diff --git a/discovery/accessapproval-v1.json b/discovery/accessapproval-v1.json index 35808321aec..09258324fc0 100644 --- a/discovery/accessapproval-v1.json +++ b/discovery/accessapproval-v1.json @@ -913,7 +913,7 @@ } } }, - "revision": "20250206", + "revision": "20250411", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { @@ -944,6 +944,15 @@ "readOnly": true, "type": "boolean" }, + "approvalPolicy": { + "$ref": "CustomerApprovalApprovalPolicy", + "description": "Optional. Policy for approval. This contains all policies." + }, + "effectiveApprovalPolicy": { + "$ref": "CustomerApprovalApprovalPolicy", + "description": "Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.", + "readOnly": true + }, "enrolledAncestor": { "description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).", "readOnly": true, @@ -1144,6 +1153,10 @@ "format": "google-datetime", "type": "string" }, + "policyApproved": { + "description": "True when the request has been approved by the customer's defined policy.", + "type": "boolean" + }, "signatureInfo": { "$ref": "SignatureInfo", "description": "The signature for the ApprovalRequest and details on how it was signed." @@ -1162,6 +1175,31 @@ }, "type": "object" }, + "CustomerApprovalApprovalPolicy": { + "description": "Represents all the policies that can be set for Customer Approval.", + "id": "CustomerApprovalApprovalPolicy", + "properties": { + "justificationBasedApprovalPolicy": { + "description": "Optional. Policy for approval based on the justification given.", + "enum": [ + "JUSTIFICATION_BASED_APPROVAL_POLICY_UNSPECIFIED", + "JUSTIFICATION_BASED_APPROVAL_ENABLED_ALL", + "JUSTIFICATION_BASED_APPROVAL_ENABLED_EXTERNAL_JUSTIFICATIONS", + "JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED", + "JUSTIFICATION_BASED_APPROVAL_INHERITED" + ], + "enumDescriptions": [ + "Default value for proto.", + "Instant approval is enabled for all accesses.", + "Instant approval is enabled for external justifications.", + "Instant approval is not enabled for any accesses.", + "Instant approval is inherited from the parent." + ], + "type": "string" + } + }, + "type": "object" + }, "DismissApprovalRequestMessage": { "description": "Request to dismiss an approval request.", "id": "DismissApprovalRequestMessage", diff --git a/discovery/accesscontextmanager-v1.json b/discovery/accesscontextmanager-v1.json index a1eab93cc13..ddd3b3beeca 100644 --- a/discovery/accesscontextmanager-v1.json +++ b/discovery/accesscontextmanager-v1.json @@ -1206,7 +1206,7 @@ ], "parameters": { "append": { - "description": "Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite. So far, only scoped_access_settings with reauth_settings supports appending. Global access_levels, access_levels in scoped_access_settings, dry_run_access_levels, reauth_settings, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when \"scoped_access_settings\" is not set in the update_mask.", + "description": "Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite. So far, only scoped_access_settings with session_settings supports appending. Global access_levels, access_levels in scoped_access_settings, dry_run_access_levels, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when \"scoped_access_settings\" is not set in the update_mask.", "location": "query", "type": "boolean" }, @@ -1218,7 +1218,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `reauth_settings` `session_settings`, `scoped_access_settings`. update_mask { paths: \"access_levels\" }", + "description": "Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `session_settings`, `scoped_access_settings`. update_mask { paths: \"access_levels\" }", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1295,7 +1295,7 @@ } } }, - "revision": "20250312", + "revision": "20250412", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/discovery/addressvalidation-v1.json b/discovery/addressvalidation-v1.json index 1f3d9b164f1..c01f03b22e1 100644 --- a/discovery/addressvalidation-v1.json +++ b/discovery/addressvalidation-v1.json @@ -151,7 +151,7 @@ } } }, - "revision": "20241120", + "revision": "20250330", "rootUrl": "https://addressvalidation.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -185,7 +185,7 @@ "type": "string" }, "missingComponentTypes": { - "description": "The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. Components of this type are not present in `formatted_address`, `postal_address`, or `address_components`. An example might be `['street_number', 'route']` for an input like \"Boulder, Colorado, 80301, USA\". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).", + "description": "The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. An example might be `['street_number', 'route']` for an input like \"Boulder, Colorado, 80301, USA\". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). **Note: you might see a missing component type when you think you've already supplied the missing component.** For example, this can happen when the input address contains the building name, but not the premise number. In the address \"渋谷区渋谷３丁目　Shibuya Stream\", the building name \"Shibuya Stream\" has the component type `premise`, but the premise number is missing, so `missing_component_types` will contain `premise`.", "items": { "type": "string" }, @@ -705,7 +705,7 @@ "type": "boolean" }, "inputGranularity": { - "description": "The granularity of the **input** address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to `validation_granularity` below. For example, if the input address includes a specific apartment number, then the `input_granularity` here will be `SUB_PREMISE`. If we cannot match the apartment number in the databases or the apartment number is invalid, the `validation_granularity` will likely be `PREMISE` or below.", + "description": "The granularity of the **input** address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to `validation_granularity` below. For example, if the input address includes a specific apartment number, then the `input_granularity` here will be `SUB_PREMISE`. If we cannot match the apartment number in the databases or the apartment number is invalid, the `validation_granularity` will likely be `PREMISE` or worse.", "enum": [ "GRANULARITY_UNSPECIFIED", "SUB_PREMISE", @@ -769,18 +769,18 @@ "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", + "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 or 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).", + "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 or 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). In 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.", + "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. 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": { @@ -788,7 +788,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -796,7 +796,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -816,11 +816,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/admin-datatransfer_v1.json b/discovery/admin-datatransfer_v1.json index 6b87391860c..0bedce6a69e 100644 --- a/discovery/admin-datatransfer_v1.json +++ b/discovery/admin-datatransfer_v1.json @@ -17,7 +17,7 @@ "canonicalName": "DataTransfer", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/admin-sdk/", + "documentationLink": "https://developers.google.com/workspace/admin/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -272,7 +272,7 @@ } } }, - "revision": "20221205", + "revision": "20250421", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index d90339118c1..56ead0dabd2 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -98,7 +98,7 @@ "canonicalName": "directory", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/admin-sdk/", + "documentationLink": "https://developers.google.com/workspace/admin/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1011,7 +1011,7 @@ ], "parameters": { "name": { - "description": "Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`", + "description": "Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`", "location": "path", "pattern": "^customers/[^/]+/chrome/printServers/[^/]+$", "required": true, @@ -1284,7 +1284,7 @@ "type": "string" }, "name": { - "description": "The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)", + "description": "Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)", "location": "path", "pattern": "^customers/[^/]+/chrome/printers/[^/]+$", "required": true, @@ -4671,7 +4671,7 @@ } } }, - "revision": "20250217", + "revision": "20250421", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -7202,7 +7202,7 @@ "type": "string" }, "name": { - "description": "Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`", + "description": "Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`", "type": "string" }, "orgUnitId": { @@ -7312,7 +7312,7 @@ "type": "string" }, "name": { - "description": "The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)", + "description": "Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)", "type": "string" }, "orgUnitId": { diff --git a/discovery/admin-reports_v1.json b/discovery/admin-reports_v1.json index 92cab795c84..18bdcc3264a 100644 --- a/discovery/admin-reports_v1.json +++ b/discovery/admin-reports_v1.json @@ -17,7 +17,7 @@ "canonicalName": "reports", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/admin-sdk/", + "documentationLink": "https://developers.google.com/workspace/admin/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -626,7 +626,7 @@ } } }, - "revision": "20250304", + "revision": "20250424", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { @@ -663,6 +663,24 @@ "actor": { "description": "User doing the action.", "properties": { + "applicationInfo": { + "description": "Details of the application that was the actor for the activity.", + "properties": { + "applicationName": { + "description": "Name of the application used to perform the action.", + "type": "string" + }, + "impersonation": { + "description": "Whether the application was impersonating a user.", + "type": "boolean" + }, + "oauthClientId": { + "description": "OAuth client id of the third party application used to perform the action.", + "type": "string" + } + }, + "type": "object" + }, "callerType": { "description": "The type of actor.", "type": "string" @@ -764,6 +782,13 @@ }, "type": "array" }, + "resourceIds": { + "description": "Resource ids associated with the event.", + "items": { + "type": "string" + }, + "type": "array" + }, "type": { "description": "Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.", "type": "string" @@ -809,6 +834,39 @@ "ownerDomain": { "description": "This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.", "type": "string" + }, + "resourceDetails": { + "description": "Details of the resource on which the action was performed.", + "items": { + "$ref": "ResourceDetails" + }, + "type": "array" + } + }, + "type": "object" + }, + "AppliedLabel": { + "description": "Details of the label applied on the resource.", + "id": "AppliedLabel", + "properties": { + "fieldValues": { + "description": "List of fields which are part of the label and have been set by the user. If label has a field which was not set by the user, it would not be present in this list.", + "items": { + "$ref": "FieldValue" + }, + "type": "array" + }, + "id": { + "description": "Identifier of the label - Only the label id, not the full OnePlatform resource name.", + "type": "string" + }, + "reason": { + "$ref": "Reason", + "description": "The reason why the label was applied on the resource." + }, + "title": { + "description": "Title of the label", + "type": "string" } }, "type": "object" @@ -865,6 +923,164 @@ }, "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" + }, + "FieldValue": { + "description": "Details of the field value set by the user for the particular label.", + "id": "FieldValue", + "properties": { + "dateValue": { + "$ref": "Date", + "description": "Setting a date value." + }, + "displayName": { + "description": "Display name of the field", + "type": "string" + }, + "id": { + "description": "Identifier of the field", + "type": "string" + }, + "integerValue": { + "description": "Setting an integer value.", + "format": "int64", + "type": "string" + }, + "longTextValue": { + "description": "Setting a long text value.", + "type": "string" + }, + "reason": { + "$ref": "Reason", + "description": "The reason why the field was applied to the label." + }, + "selectionListValue": { + "$ref": "FieldValueSelectionListValue", + "description": "Setting a selection list value by selecting multiple values from a dropdown." + }, + "selectionValue": { + "$ref": "FieldValueSelectionValue", + "description": "Setting a selection value by selecting a single value from a dropdown." + }, + "textListValue": { + "$ref": "FieldValueTextListValue", + "description": "Setting a text list value." + }, + "textValue": { + "description": "Setting a text value.", + "type": "string" + }, + "type": { + "description": "Type of the field", + "type": "string" + }, + "unsetValue": { + "description": "If the field is unset, this will be true.", + "type": "boolean" + }, + "userListValue": { + "$ref": "FieldValueUserListValue", + "description": "Setting a user list value by selecting multiple users." + }, + "userValue": { + "$ref": "FieldValueUserValue", + "description": "Setting a user value by selecting a single user." + } + }, + "type": "object" + }, + "FieldValueSelectionListValue": { + "description": "Setting a selection list value by selecting multiple values from a dropdown.", + "id": "FieldValueSelectionListValue", + "properties": { + "values": { + "description": "List of selections.", + "items": { + "$ref": "FieldValueSelectionValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "FieldValueSelectionValue": { + "description": "Setting a selection value by selecting a single value from a dropdown.", + "id": "FieldValueSelectionValue", + "properties": { + "badged": { + "description": "Whether the selection is badged.", + "type": "boolean" + }, + "displayName": { + "description": "Display name of the selection.", + "type": "string" + }, + "id": { + "description": "Identifier of the selection.", + "type": "string" + } + }, + "type": "object" + }, + "FieldValueTextListValue": { + "description": "Setting a text list value.", + "id": "FieldValueTextListValue", + "properties": { + "values": { + "description": "List of text values.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FieldValueUserListValue": { + "description": "Setting a user list value by selecting multiple users.", + "id": "FieldValueUserListValue", + "properties": { + "values": { + "description": "List of users.", + "items": { + "$ref": "FieldValueUserValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "FieldValueUserValue": { + "description": "Setting a user value by selecting a single user.", + "id": "FieldValueUserValue", + "properties": { + "email": { + "description": "Email of the user.", + "type": "string" + } + }, + "type": "object" + }, "NestedParameter": { "description": "JSON template for a parameter used in various reports.", "id": "NestedParameter", @@ -911,6 +1127,47 @@ }, "type": "object" }, + "Reason": { + "description": "The reason why the label/field was applied.", + "id": "Reason", + "properties": { + "reasonType": { + "description": "The type of the reason.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceDetails": { + "description": "Details of the resource on which the action was performed.", + "id": "ResourceDetails", + "properties": { + "appliedLabels": { + "description": "List of labels applied on the resource", + "items": { + "$ref": "AppliedLabel" + }, + "type": "array" + }, + "id": { + "description": "Identifier of the resource.", + "type": "string" + }, + "relation": { + "description": "Defines relationship of the resource to the events", + "type": "string" + }, + "title": { + "description": "Title of the resource. For instance, in case of a drive document, this would be the title of the document. In case of an email, this would be the subject.", + "type": "string" + }, + "type": { + "description": "Type of the resource - document, email, chat message", + "type": "string" + } + }, + "type": "object" + }, "UsageReport": { "description": "JSON template for a usage report.", "id": "UsageReport", diff --git a/discovery/adsense-v2.json b/discovery/adsense-v2.json index 99b2001b687..076886dabf4 100644 --- a/discovery/adsense-v2.json +++ b/discovery/adsense-v2.json @@ -1193,8 +1193,8 @@ "Number of page views.", "Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available.", "Requests that returned at least one ad.", - "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", - "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user's device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user's device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", "Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads.", "Number of times a user clicked on a standard content ad.", "Fraction of page views considered to be spam. Only available to premium accounts.", @@ -1221,7 +1221,7 @@ "Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.", "Number of ad views per impression.", "Total earnings are the gross estimated earnings from revenue shared traffic before any parent and child account revenue share is applied.", - "Number of results pages.", + "Number of results pages. This metric can only be used when generating a report in the Google timezone, not the account timezone. Since the account timezone is the default for report generation, this metric can only be used by explicitly specifying `reportingTimeZone=GOOGLE_TIME_ZONE`.", "Number of requests for non-ad units (for example a related search unit). For more information, see [Funnel requests](https://support.google.com/adsense/answer/11586959).", "Number of requests for non-ad units ads that returned content that was shown to the user. For more information, see [Funnel impressions](https://support.google.com/adsense/answer/11585767).", "Number of times a user clicked on a non-ad unit, triggering further ad requests. For more information, see [Funnel clicks](https://support.google.com/adsense/answer/11586382).", @@ -1566,8 +1566,8 @@ "Number of page views.", "Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available.", "Requests that returned at least one ad.", - "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", - "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user's device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", + "Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user's device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads.", "Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads.", "Number of times a user clicked on a standard content ad.", "Fraction of page views considered to be spam. Only available to premium accounts.", @@ -1594,7 +1594,7 @@ "Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.", "Number of ad views per impression.", "Total earnings are the gross estimated earnings from revenue shared traffic before any parent and child account revenue share is applied.", - "Number of results pages.", + "Number of results pages. This metric can only be used when generating a report in the Google timezone, not the account timezone. Since the account timezone is the default for report generation, this metric can only be used by explicitly specifying `reportingTimeZone=GOOGLE_TIME_ZONE`.", "Number of requests for non-ad units (for example a related search unit). For more information, see [Funnel requests](https://support.google.com/adsense/answer/11586959).", "Number of requests for non-ad units ads that returned content that was shown to the user. For more information, see [Funnel impressions](https://support.google.com/adsense/answer/11585767).", "Number of times a user clicked on a non-ad unit, triggering further ad requests. For more information, see [Funnel clicks](https://support.google.com/adsense/answer/11586382).", @@ -2018,7 +2018,7 @@ } } }, - "revision": "20250313", + "revision": "20250320", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 613a51881e3..8609a2617d6 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -54,6 +54,11 @@ "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", "location": "asia-south1" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-south2-aiplatform.googleapis.com/", + "location": "asia-south2" + }, { "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", @@ -310,6 +315,102 @@ }, "protocol": "rest", "resources": { + "batchPredictionJobs": { + "methods": { + "create": { + "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "flatPath": "v1/batchPredictionJobs", + "httpMethod": "POST", + "id": "aiplatform.batchPredictionJobs.create", + "parameterOrder": [], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/batchPredictionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a BatchPredictionJob", + "flatPath": "v1/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.batchPredictionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BatchPredictionJobs in a Location.", + "flatPath": "v1/batchPredictionJobs", + "httpMethod": "GET", + "id": "aiplatform.batchPredictionJobs.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/batchPredictionJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "datasets": { "methods": { "create": { @@ -822,6 +923,41 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] } + }, + "resources": { + "chat": { + "methods": { + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1/endpoints/{endpointsId}/chat/completions", + "httpMethod": "POST", + "id": "aiplatform.endpoints.chat.completions", + "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}/chat/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } } }, "media": { @@ -1073,6 +1209,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2643,7 +2785,7 @@ "annotations": { "methods": { "list": { - "description": "Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.", + "description": "Lists Annotations belongs to a dataitem.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", "httpMethod": "GET", "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", @@ -4865,6 +5007,37 @@ "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}/featureGroups/{featureGroupsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.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/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists FeatureGroups in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", @@ -4944,6 +5117,65 @@ "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}/featureGroups/{featureGroupsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.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/[^/]+/featureGroups/[^/]+$", + "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}/featureGroups/{featureGroupsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -15262,6 +15494,161 @@ } } }, + "ragEngineConfig": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "reasoningEngines": { "methods": { "create": { @@ -15301,6 +15688,11 @@ "name" ], "parameters": { + "force": { + "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", @@ -19449,7 +19841,7 @@ } } }, - "revision": "20250307", + "revision": "20250422", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -20339,7 +20731,7 @@ "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.", + "description": "Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.", "type": "boolean" }, "samplingCount": { @@ -21841,6 +22233,34 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ContentMap": { + "description": "Map of placeholder in metric prompt template to contents of model input.", + "id": "GoogleCloudAiplatformV1ContentMap", + "properties": { + "values": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ContentMapContents" + }, + "description": "Optional. Map of placeholder to contents.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ContentMapContents": { + "description": "Repeated Content type.", + "id": "GoogleCloudAiplatformV1ContentMapContents", + "properties": { + "contents": { + "description": "Optional. Repeated contents.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Context": { "description": "Instance of a general context.", "id": "GoogleCloudAiplatformV1Context", @@ -22640,6 +23060,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CustomOutput": { + "description": "Spec for custom output.", + "id": "GoogleCloudAiplatformV1CustomOutput", + "properties": { + "rawOutputs": { + "$ref": "GoogleCloudAiplatformV1RawOutput", + "description": "Output only. List of raw output strings.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CustomOutputFormatConfig": { + "description": "Spec for custom output format configuration.", + "id": "GoogleCloudAiplatformV1CustomOutputFormatConfig", + "properties": { + "returnRawOutput": { + "description": "Optional. Whether to return raw output.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1DataItem": { "description": "A piece of data in a Dataset. Could be an image, a video, a document or plain text.", "id": "GoogleCloudAiplatformV1DataItem", @@ -23688,7 +24131,7 @@ "type": "string" }, "dedicatedEndpointDns": { - "description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", + "description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: `https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog`.", "readOnly": true, "type": "string" }, @@ -23940,7 +24383,7 @@ "properties": { "autoraterConfig": { "$ref": "GoogleCloudAiplatformV1AutoraterConfig", - "description": "Optional. Autorater config used for evaluation." + "description": "Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.`" }, "dataset": { "$ref": "GoogleCloudAiplatformV1EvaluationDataset", @@ -24036,6 +24479,10 @@ "$ref": "GoogleCloudAiplatformV1RougeInput", "description": "Instances and metric spec for rouge metric." }, + "rubricBasedInstructionFollowingInput": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput", + "description": "Rubric Based Instruction Following metric." + }, "safetyInput": { "$ref": "GoogleCloudAiplatformV1SafetyInput", "description": "Input for safety metric." @@ -24167,6 +24614,10 @@ "$ref": "GoogleCloudAiplatformV1RougeResults", "description": "Results for rouge metric." }, + "rubricBasedInstructionFollowingResult": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult", + "description": "Result for rubric based instruction following metric." + }, "safetyResult": { "$ref": "GoogleCloudAiplatformV1SafetyResult", "description": "Result for safety metric." @@ -24315,7 +24766,7 @@ }, "gcsSource": { "$ref": "GoogleCloudAiplatformV1GcsSource", - "description": "Cloud storage source holds the dataset." + "description": "Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported." } }, "type": "object" @@ -25387,6 +25838,10 @@ "description": "The fact used in grounding.", "id": "GoogleCloudAiplatformV1Fact", "properties": { + "chunk": { + "$ref": "GoogleCloudAiplatformV1RagChunk", + "description": "If present, chunk properties." + }, "query": { "description": "Query that is used to retrieve this fact.", "type": "string" @@ -25549,6 +26004,25 @@ "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", "type": "string" }, + "serviceAccountEmail": { + "description": "Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.", + "readOnly": true, + "type": "string" + }, + "serviceAgentType": { + "description": "Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. 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_GROUP" + ], + "enumDescriptions": [ + "By default, the project-level Vertex AI Service Agent is enabled.", + "Specifies the project-level Vertex AI Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).", + "Enable a FeatureGroup 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 jobs under a FeatureGroup." + ], + "type": "string" + }, "updateTime": { "description": "Output only. Timestamp when this FeatureGroup was last updated.", "format": "google-datetime", @@ -26925,7 +27399,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", + "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", "type": "object" }, "name": { @@ -27023,7 +27497,7 @@ "id": "GoogleCloudAiplatformV1GcsSource", "properties": { "uris": { - "description": "Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.", + "description": "Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.", "items": { "type": "string" }, @@ -27252,6 +27726,21 @@ "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", "format": "int32", "type": "integer" + }, + "trafficType": { + "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "ON_DEMAND", + "PROVISIONED_THROUGHPUT" + ], + "enumDescriptions": [ + "Unspecified request traffic type.", + "Type for Pay-As-You-Go traffic.", + "Type for Provisioned Throughput traffic." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -27414,6 +27903,10 @@ "format": "float", "type": "number" }, + "thinkingConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", + "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", @@ -27470,12 +27963,24 @@ "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { - "description": "The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.", + "description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", "type": "string" } }, "type": "object" }, + "GoogleCloudAiplatformV1GenerationConfigThinkingConfig": { + "description": "Config for thinking features.", + "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", + "properties": { + "thinkingBudget": { + "description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenericOperationMetadata": { "description": "Generic Metadata shared by all operations.", "id": "GoogleCloudAiplatformV1GenericOperationMetadata", @@ -27649,6 +28154,10 @@ "description": "Chunk from context retrieved by the retrieval tools.", "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", "properties": { + "ragChunk": { + "$ref": "GoogleCloudAiplatformV1RagChunk", + "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." + }, "text": { "description": "Text of the attribution.", "type": "string" @@ -27668,6 +28177,10 @@ "description": "Chunk from the web.", "id": "GoogleCloudAiplatformV1GroundingChunkWeb", "properties": { + "domain": { + "description": "Domain of the (original) URI.", + "type": "string" + }, "title": { "description": "Title of the chunk.", "type": "string" @@ -31567,6 +32080,7 @@ "type": "object" }, "GoogleCloudAiplatformV1ModelVersionCheckpoint": { + "deprecated": true, "description": "Describes the machine learning model version checkpoint.", "id": "GoogleCloudAiplatformV1ModelVersionCheckpoint", "properties": { @@ -31579,10 +32093,6 @@ "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", @@ -32236,7 +32746,8 @@ "INVALID_SPARSE_DIMENSIONS", "INVALID_TOKEN_VALUE", "INVALID_SPARSE_EMBEDDING", - "INVALID_EMBEDDING" + "INVALID_EMBEDDING", + "INVALID_EMBEDDING_METADATA" ], "enumDescriptions": [ "Default, shall not be used.", @@ -32256,7 +32767,8 @@ "Error parsing sparse dimensions field.", "Token restrict value is invalid.", "Invalid sparse embedding.", - "Invalid dense embedding." + "Invalid dense embedding.", + "Invalid embedding metadata." ], "type": "string" }, @@ -32586,6 +33098,40 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1NotebookReservationAffinity": { + "description": "Notebook Reservation Affinity for consuming Zonal reservation.", + "id": "GoogleCloudAiplatformV1NotebookReservationAffinity", + "properties": { + "consumeReservationType": { + "description": "Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples.", + "enum": [ + "RESERVATION_AFFINITY_TYPE_UNSPECIFIED", + "RESERVATION_NONE", + "RESERVATION_ANY", + "RESERVATION_SPECIFIC" + ], + "enumDescriptions": [ + "Default type.", + "Do not consume from any allocated capacity.", + "Consume any reservation available.", + "Must consume from a specific reservation. Must specify key value fields for specifying the reservations." + ], + "type": "string" + }, + "key": { + "description": "Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.", + "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1NotebookRuntime": { "description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.", "id": "GoogleCloudAiplatformV1NotebookRuntime", @@ -32704,6 +33250,11 @@ "readOnly": true, "type": "string" }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1NotebookReservationAffinity", + "description": "Output only. Reservation Affinity of the notebook runtime.", + "readOnly": true + }, "runtimeState": { "description": "Output only. The runtime (instance) state of the NotebookRuntime.", "enum": [ @@ -32856,6 +33407,10 @@ ], "type": "string" }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1NotebookReservationAffinity", + "description": "Optional. Reservation Affinity of the notebook runtime template." + }, "serviceAccount": { "deprecated": true, "description": "Deprecated: This field is ignored and the \"Vertex AI Notebook Service Account\" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", @@ -32952,6 +33507,10 @@ "description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", "id": "GoogleCloudAiplatformV1PairwiseMetricInstance", "properties": { + "contentMapInstance": { + "$ref": "GoogleCloudAiplatformV1ContentMap", + "description": "Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content." + }, "jsonInstance": { "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", "type": "string" @@ -32963,6 +33522,11 @@ "description": "Spec for pairwise metric result.", "id": "GoogleCloudAiplatformV1PairwiseMetricResult", "properties": { + "customOutput": { + "$ref": "GoogleCloudAiplatformV1CustomOutput", + "description": "Output only. Spec for custom output.", + "readOnly": true + }, "explanation": { "description": "Output only. Explanation for pairwise metric score.", "readOnly": true, @@ -33000,6 +33564,10 @@ "description": "Optional. The field name of the candidate response.", "type": "string" }, + "customOutputFormatConfig": { + "$ref": "GoogleCloudAiplatformV1CustomOutputFormatConfig", + "description": "Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty." + }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pairwise metric.", "type": "string" @@ -33861,6 +34429,10 @@ "description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", "id": "GoogleCloudAiplatformV1PointwiseMetricInstance", "properties": { + "contentMapInstance": { + "$ref": "GoogleCloudAiplatformV1ContentMap", + "description": "Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content." + }, "jsonInstance": { "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", "type": "string" @@ -33872,6 +34444,11 @@ "description": "Spec for pointwise metric result.", "id": "GoogleCloudAiplatformV1PointwiseMetricResult", "properties": { + "customOutput": { + "$ref": "GoogleCloudAiplatformV1CustomOutput", + "description": "Output only. Spec for custom output.", + "readOnly": true + }, "explanation": { "description": "Output only. Explanation for pointwise metric score.", "readOnly": true, @@ -33890,6 +34467,10 @@ "description": "Spec for pointwise metric.", "id": "GoogleCloudAiplatformV1PointwiseMetricSpec", "properties": { + "customOutputFormatConfig": { + "$ref": "GoogleCloudAiplatformV1CustomOutputFormatConfig", + "description": "Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty." + }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pointwise metric.", "type": "string" @@ -34236,7 +34817,7 @@ "type": "integer" }, "service": { - "description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.", + "description": "Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.", "type": "string" } }, @@ -35237,6 +35818,38 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RagChunk": { + "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.", + "id": "GoogleCloudAiplatformV1RagChunk", + "properties": { + "pageSpan": { + "$ref": "GoogleCloudAiplatformV1RagChunkPageSpan", + "description": "If populated, represents where the chunk starts and ends in the document." + }, + "text": { + "description": "The content of the chunk.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagChunkPageSpan": { + "description": "Represents where the chunk starts and ends in the document.", + "id": "GoogleCloudAiplatformV1RagChunkPageSpan", + "properties": { + "firstPage": { + "description": "Page where chunk starts in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" + }, + "lastPage": { + "description": "Page where chunk ends in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RagContexts": { "description": "Relevant contexts for one query.", "id": "GoogleCloudAiplatformV1RagContexts", @@ -35255,6 +35868,10 @@ "description": "A context of the query.", "id": "GoogleCloudAiplatformV1RagContextsContext", "properties": { + "chunk": { + "$ref": "GoogleCloudAiplatformV1RagChunk", + "description": "Context of the retrieved chunk." + }, "score": { "description": "According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.", "format": "double", @@ -35312,6 +35929,10 @@ "vectorDbConfig": { "$ref": "GoogleCloudAiplatformV1RagVectorDbConfig", "description": "Optional. Immutable. The config for the Vector DBs." + }, + "vertexAiSearchConfig": { + "$ref": "GoogleCloudAiplatformV1VertexAiSearchConfig", + "description": "Optional. Immutable. The config for the Vertex AI Search." } }, "type": "object" @@ -35501,6 +36122,10 @@ "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigFilter", "description": "Optional. Config for filters." }, + "ranking": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRanking", + "description": "Optional. Config for ranking and reranking." + }, "topK": { "description": "Optional. The number of contexts to retrieve.", "format": "int32", @@ -35530,6 +36155,43 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RagRetrievalConfigRanking": { + "description": "Config for ranking and reranking.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfigRanking", + "properties": { + "llmRanker": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker", + "description": "Optional. Config for LlmRanker." + }, + "rankService": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService", + "description": "Optional. Config for Rank Service." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker": { + "description": "Config for LlmRanker.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker", + "properties": { + "modelName": { + "description": "Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService": { + "description": "Config for Rank Service.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService", + "properties": { + "modelName": { + "description": "Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RagVectorDbConfig": { "description": "Config for the Vector DB to use for RAG.", "id": "GoogleCloudAiplatformV1RagVectorDbConfig", @@ -35589,6 +36251,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RawOutput": { + "description": "Raw output.", + "id": "GoogleCloudAiplatformV1RawOutput", + "properties": { + "rawOutput": { + "description": "Output only. Raw output string.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RawPredictRequest": { "description": "Request message for PredictionService.RawPredict.", "id": "GoogleCloudAiplatformV1RawPredictRequest", @@ -35885,7 +36562,7 @@ }, "spec": { "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpec", - "description": "Required. Configurations of the ReasoningEngine" + "description": "Optional. Configurations of the ReasoningEngine" }, "updateTime": { "description": "Output only. Timestamp when this ReasoningEngine was most recently updated.", @@ -35901,7 +36578,7 @@ "id": "GoogleCloudAiplatformV1ReasoningEngineSpec", "properties": { "agentFramework": { - "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"langchain\", \"langgraph\", \"ag2\", \"custom\".", + "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" }, "classMethods": { @@ -35921,7 +36598,7 @@ }, "packageSpec": { "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", - "description": "Required. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes." + "description": "Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes." } }, "type": "object" @@ -36401,6 +37078,76 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput": { + "description": "Instance and metric spec for RubricBasedInstructionFollowing metric.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance", + "description": "Required. Instance for RubricBasedInstructionFollowing metric." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec", + "description": "Required. Spec for RubricBasedInstructionFollowing metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance": { + "description": "Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance", + "properties": { + "jsonInstance": { + "description": "Required. Instance specified as a json string. String key-value pairs are expected in the json_instance to render RubricBasedInstructionFollowing prompt templates.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult": { + "description": "Result for RubricBasedInstructionFollowing metric.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult", + "properties": { + "rubricCritiqueResults": { + "description": "Output only. List of per rubric critique results.", + "items": { + "$ref": "GoogleCloudAiplatformV1RubricCritiqueResult" + }, + "readOnly": true, + "type": "array" + }, + "score": { + "description": "Output only. Overall score for the instruction following.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec": { + "description": "Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricCritiqueResult": { + "description": "Rubric critique result.", + "id": "GoogleCloudAiplatformV1RubricCritiqueResult", + "properties": { + "rubric": { + "description": "Output only. Rubric to be evaluated.", + "readOnly": true, + "type": "string" + }, + "verdict": { + "description": "Output only. Verdict for the rubric - true if the rubric is met, false otherwise.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1SafetyInput": { "description": "Input for safety metric.", "id": "GoogleCloudAiplatformV1SafetyInput", @@ -36446,13 +37193,21 @@ "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true + ], "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." + "Deprecated: Election filter is not longer supported. The harm category is civic integrity." ], "readOnly": true, "type": "string" @@ -36548,13 +37303,21 @@ "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true + ], "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." + "Deprecated: Election filter is not longer supported. The harm category is civic integrity." ], "type": "string" }, @@ -37042,7 +37805,8 @@ "INTEGER", "BOOLEAN", "ARRAY", - "OBJECT" + "OBJECT", + "NULL" ], "enumDescriptions": [ "Not specified, should not be used.", @@ -37051,7 +37815,8 @@ "OpenAPI integer type", "OpenAPI boolean type", "OpenAPI array type", - "OpenAPI object type" + "OpenAPI object type", + "Null type" ], "type": "string" } @@ -41381,7 +42146,7 @@ "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.", + "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.", "type": "string" }, "version": { @@ -41669,6 +42434,10 @@ "description": "The speech generation config.", "id": "GoogleCloudAiplatformV1SpeechConfig", "properties": { + "languageCode": { + "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", + "type": "string" + }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1VoiceConfig", "description": "The configuration for the speaker to use." @@ -44553,7 +45322,7 @@ "id": "GoogleCloudAiplatformV1TuningJob", "properties": { "baseModel": { - "description": "The base model that is being tuned, e.g., \"gemini-1.0-pro-002\". .", + "description": "The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).", "type": "string" }, "createTime": { @@ -45116,6 +45885,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1VertexAiSearchConfig": { + "description": "Config for the Vertex AI Search.", + "id": "GoogleCloudAiplatformV1VertexAiSearchConfig", + "properties": { + "servingConfig": { + "description": "Vertex AI Search Serving Config resource full name. For example, `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1VertexRagStore": { "description": "Retrieve from Vertex RAG Store for grounding.", "id": "GoogleCloudAiplatformV1VertexRagStore", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 4cf587a34cd..4c36c4a172d 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -54,6 +54,11 @@ "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", "location": "asia-south1" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-south2-aiplatform.googleapis.com/", + "location": "asia-south2" + }, { "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", @@ -310,6 +315,102 @@ }, "protocol": "rest", "resources": { + "batchPredictionJobs": { + "methods": { + "create": { + "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "flatPath": "v1beta1/batchPredictionJobs", + "httpMethod": "POST", + "id": "aiplatform.batchPredictionJobs.create", + "parameterOrder": [], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/batchPredictionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a BatchPredictionJob", + "flatPath": "v1beta1/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.batchPredictionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BatchPredictionJobs in a Location.", + "flatPath": "v1beta1/batchPredictionJobs", + "httpMethod": "GET", + "id": "aiplatform.batchPredictionJobs.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/batchPredictionJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "datasets": { "methods": { "create": { @@ -823,6 +924,41 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] } + }, + "resources": { + "chat": { + "methods": { + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1beta1/endpoints/{endpointsId}/chat/completions", + "httpMethod": "POST", + "id": "aiplatform.endpoints.chat.completions", + "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}/chat/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } } }, "media": { @@ -1122,6 +1258,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getRagEngineConfig": { + "description": "Gets a RagEngineConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.getRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v1beta1/projects/{projectsId}/locations", @@ -1131,6 +1292,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1190,6 +1357,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateRagEngineConfig": { + "description": "Updates a RagEngineConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.updateRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -3067,7 +3262,7 @@ "annotations": { "methods": { "list": { - "description": "Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.", + "description": "Lists Annotations belongs to a dataitem.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", "httpMethod": "GET", "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", @@ -5571,6 +5766,302 @@ } }, "exampleStores": { + "methods": { + "create": { + "description": "Create an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores:create", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "exampleStore.createTime": { + "description": "Output only. Timestamp when this ExampleStore was created.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "exampleStore.description": { + "description": "Optional. Description of the ExampleStore.", + "location": "query", + "type": "string" + }, + "exampleStore.displayName": { + "description": "Required. Display name of the ExampleStore.", + "location": "query", + "type": "string" + }, + "exampleStore.exampleStoreConfig.vertexEmbeddingModel": { + "description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"", + "location": "query", + "type": "string" + }, + "exampleStore.name": { + "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", + "location": "query", + "type": "string" + }, + "exampleStore.updateTime": { + "description": "Output only. Timestamp when this ExampleStore was most recently updated.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/exampleStores:create", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.exampleStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchExamples": { + "description": "Get Examples from the Example Store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:fetchExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.fetchExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:fetchExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.exampleStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List ExampleStores in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.exampleStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/exampleStores", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.exampleStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeExamples": { + "description": "Remove Examples from the Example Store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:removeExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.removeExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:removeExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchExamples": { + "description": "Search for similar Examples for given selection criteria.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:searchExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.searchExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:searchExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upsertExamples": { + "description": "Create or update Examples in the Example Store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:upsertExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.upsertExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:upsertExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -7726,6 +8217,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "directWrite": { + "description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:directWrite", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "fetchFeatureValues": { "description": "Fetch feature values under a FeatureView.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", @@ -17104,6 +17623,42 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "export": { + "description": "Exports a publisher model to a user provided Google Cloud Storage bucket.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:export", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.export", + "parameterOrder": [ + "parent", + "name" + ], + "parameters": { + "name": { + "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`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The Location to export the model weights from Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/{+name}:export", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "fetchPredictOperation": { "description": "Fetch an asynchronous online prediction operation.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", @@ -17133,6 +17688,31 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "fetchPublisherModelConfig": { + "description": "Fetches the configs of publisher models.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPublisherModelConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.publishers.models.fetchPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:fetchPublisherModelConfig", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "generateContent": { "description": "Generate content with multimodal inputs.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent", @@ -17309,6 +17889,34 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "setPublisherModelConfig": { + "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:setPublisherModelConfig", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.setPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:setPublisherModelConfig", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "streamGenerateContent": { "description": "Generate content with multimodal inputs with streaming support.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", @@ -17946,6 +18554,161 @@ } } }, + "ragEngineConfig": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "reasoningEngines": { "methods": { "create": { @@ -17985,6 +18748,11 @@ "name" ], "parameters": { + "force": { + "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", @@ -18309,6 +19077,238 @@ ] } } + }, + "sessions": { + "methods": { + "appendEvent": { + "description": "Appends an event to a given session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:appendEvent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/sessions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes details of the specific Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Sessions in a given reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/sessions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the specific Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "events": { + "methods": { + "list": { + "description": "Lists Events in a given session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/events", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } }, @@ -21919,6 +22919,66 @@ } } } + }, + "modelGardenEula": { + "methods": { + "accept": { + "description": "Accepts the EULA acceptance status of a publisher model.", + "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept", + "httpMethod": "POST", + "id": "aiplatform.projects.modelGardenEula.accept", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/modelGardenEula:accept", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "check": { + "description": "Checks the EULA acceptance status of a publisher model.", + "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check", + "httpMethod": "POST", + "id": "aiplatform.projects.modelGardenEula.check", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/modelGardenEula:check", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -22210,7 +23270,7 @@ } } }, - "revision": "20250307", + "revision": "20250422", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -22651,6 +23711,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest": { + "description": "Request message for ModelGardenService.AcceptPublisherModelEula.", + "id": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest", + "properties": { + "publisherModel": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ActiveLearningConfig": { "description": "Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy.", "id": "GoogleCloudAiplatformV1beta1ActiveLearningConfig", @@ -22856,6 +23927,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AppendEventResponse": { + "description": "Response message for SessionService.AppendEvent.", + "id": "GoogleCloudAiplatformV1beta1AppendEventResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Artifact": { "description": "Instance of a general artifact.", "id": "GoogleCloudAiplatformV1beta1Artifact", @@ -22961,9 +24038,17 @@ "description": "Request message for DatasetService.AssembleData. Used only for MULTIMODAL datasets.", "id": "GoogleCloudAiplatformV1beta1AssembleDataRequest", "properties": { + "geminiRequestReadConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig", + "description": "Optional. The read config for the dataset." + }, "geminiTemplateConfig": { "$ref": "GoogleCloudAiplatformV1beta1GeminiTemplateConfig", "description": "Optional. Config for assembling templates with a Gemini API structure." + }, + "requestColumnName": { + "description": "Optional. The column name in the underlying table that contains already fully assembled requests. If this field is set, the original request will be copied to the output table.", + "type": "string" } }, "type": "object" @@ -22972,10 +24057,26 @@ "description": "Request message for DatasetService.AssessData. Used only for MULTIMODAL datasets.", "id": "GoogleCloudAiplatformV1beta1AssessDataRequest", "properties": { + "batchPredictionResourceUsageAssessmentConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig", + "description": "Optional. Configuration for the batch prediction resource usage assessment." + }, + "batchPredictionValidationAssessmentConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig", + "description": "Optional. Configuration for the batch prediction validation assessment." + }, + "geminiRequestReadConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig", + "description": "Optional. The Gemini request read config for the dataset." + }, "geminiTemplateConfig": { "$ref": "GoogleCloudAiplatformV1beta1GeminiTemplateConfig", "description": "Optional. Config for assembling templates with a Gemini API structure to assess assembled data." }, + "requestColumnName": { + "description": "Optional. The column name in the underlying table that contains already fully assembled requests.", + "type": "string" + }, "tuningResourceUsageAssessmentConfig": { "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequestTuningResourceUsageAssessmentConfig", "description": "Optional. Configuration for the tuning resource usage assessment." @@ -22987,6 +24088,28 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig": { + "description": "Configuration for the batch prediction resource usage assessment.", + "id": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig", + "properties": { + "modelName": { + "description": "Required. The name of the model used for batch prediction.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig": { + "description": "Configuration for the batch prediction validation assessment.", + "id": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig", + "properties": { + "modelName": { + "description": "Required. The name of the model used for batch prediction.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AssessDataRequestTuningResourceUsageAssessmentConfig": { "description": "Configuration for the tuning resource usage assessment.", "id": "GoogleCloudAiplatformV1beta1AssessDataRequestTuningResourceUsageAssessmentConfig", @@ -23330,7 +24453,7 @@ "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.", + "description": "Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.", "type": "boolean" }, "samplingCount": { @@ -24431,6 +25554,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest": { + "description": "Request message for ModelGardenService.CheckPublisherModelEula.", + "id": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest", + "properties": { + "publisherModel": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateMetatdata": { "description": "This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.", "id": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateMetatdata", @@ -24876,6 +26010,66 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ContentMap": { + "description": "Map of placeholder in metric prompt template to contents of model input.", + "id": "GoogleCloudAiplatformV1beta1ContentMap", + "properties": { + "values": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1ContentMapContents" + }, + "description": "Optional. Map of placeholder to contents.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ContentMapContents": { + "description": "Repeated Content type.", + "id": "GoogleCloudAiplatformV1beta1ContentMapContents", + "properties": { + "contents": { + "description": "Optional. Repeated contents.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ContentsExample": { + "description": "A single example of a conversation with the model.", + "id": "GoogleCloudAiplatformV1beta1ContentsExample", + "properties": { + "contents": { + "description": "Required. The content of the conversation with the model that resulted in the expected output.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, + "expectedContents": { + "description": "Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent": { + "description": "A single step of the expected output.", + "id": "GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent", + "properties": { + "content": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Required. A single step's content." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Context": { "description": "Instance of a general context.", "id": "GoogleCloudAiplatformV1beta1Context", @@ -25731,6 +26925,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CustomOutput": { + "description": "Spec for custom output.", + "id": "GoogleCloudAiplatformV1beta1CustomOutput", + "properties": { + "rawOutputs": { + "$ref": "GoogleCloudAiplatformV1beta1RawOutput", + "description": "Output only. List of raw output strings.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig": { + "description": "Spec for custom output format configuration.", + "id": "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig", + "properties": { + "returnRawOutput": { + "description": "Optional. Whether to return raw output.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DataItem": { "description": "A piece of data in a Dataset. Could be an image, a video, a document or plain text.", "id": "GoogleCloudAiplatformV1beta1DataItem", @@ -26529,6 +27746,13 @@ "fastTryoutEnabled": { "description": "Optional. If true, enable the QMT fast tryout feature for this model if possible.", "type": "boolean" + }, + "systemLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. System labels for Model Garden deployments. These labels are managed by Google and for tracking purposes only.", + "type": "object" } }, "type": "object" @@ -27037,7 +28261,7 @@ "id": "GoogleCloudAiplatformV1beta1DistillationSpec", "properties": { "baseTeacherModel": { - "description": "The base teacher model that is being distilled, e.g., \"gemini-1.0-pro-002\".", + "description": "The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).", "type": "string" }, "hyperParameters": { @@ -27135,7 +28359,7 @@ "type": "string" }, "dedicatedEndpointDns": { - "description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", + "description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: `https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog`.", "readOnly": true, "type": "string" }, @@ -27387,7 +28611,7 @@ "properties": { "autoraterConfig": { "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", - "description": "Optional. Autorater config used for evaluation." + "description": "Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.`" }, "dataset": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationDataset", @@ -27483,6 +28707,10 @@ "$ref": "GoogleCloudAiplatformV1beta1RougeInput", "description": "Instances and metric spec for rouge metric." }, + "rubricBasedInstructionFollowingInput": { + "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput", + "description": "Rubric Based Instruction Following metric." + }, "safetyInput": { "$ref": "GoogleCloudAiplatformV1beta1SafetyInput", "description": "Input for safety metric." @@ -27614,6 +28842,10 @@ "$ref": "GoogleCloudAiplatformV1beta1RougeResults", "description": "Results for rouge metric." }, + "rubricBasedInstructionFollowingResult": { + "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult", + "description": "Result for rubric based instruction following metric." + }, "safetyResult": { "$ref": "GoogleCloudAiplatformV1beta1SafetyResult", "description": "Result for safety metric." @@ -27762,7 +28994,7 @@ }, "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", - "description": "Cloud storage source holds the dataset." + "description": "Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported." } }, "type": "object" @@ -27810,6 +29042,88 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EventActions": { + "description": "Actions are parts of events that are executed by the agent.", + "id": "GoogleCloudAiplatformV1beta1EventActions", + "properties": { + "artifactDelta": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "Optional. Indicates that the event is updating an artifact. key is the filename, value is the version.", + "type": "object" + }, + "escalate": { + "description": "Optional. The agent is escalating to a higher level agent.", + "type": "boolean" + }, + "requestedAuthConfigs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct.", + "type": "object" + }, + "skipSummarization": { + "description": "Optional. If true, it won't call model to summarize function response. Only used for function_response event.", + "type": "boolean" + }, + "stateDelta": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Indicates that the event is updating the state with the given delta.", + "type": "object" + }, + "transferAgent": { + "description": "Optional. If set, the event transfers to the specified agent.", + "type": "string" + }, + "transferToAgent": { + "deprecated": true, + "description": "Deprecated. If set, the event transfers to the specified agent.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EventMetadata": { + "description": "Metadata relating to a LLM response event.", + "id": "GoogleCloudAiplatformV1beta1EventMetadata", + "properties": { + "branch": { + "description": "Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.", + "type": "string" + }, + "groundingMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata", + "description": "Optional. Metadata returned to client when grounding is enabled." + }, + "interrupted": { + "description": "Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.", + "type": "boolean" + }, + "longRunningToolIds": { + "description": "Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.", + "items": { + "type": "string" + }, + "type": "array" + }, + "partial": { + "description": "Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.", + "type": "boolean" + }, + "turnComplete": { + "description": "Optional. Indicates whether the response from the model is complete. Only used for streaming mode.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ExactMatchInput": { "description": "Input for exact match metric.", "id": "GoogleCloudAiplatformV1beta1ExactMatchInput", @@ -27877,6 +29191,77 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1Example": { + "description": "A single example to upload or read from the Example Store.", + "id": "GoogleCloudAiplatformV1beta1Example", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this Example was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The display name for Example.", + "type": "string" + }, + "exampleId": { + "description": "Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.", + "type": "string" + }, + "storedContentsExample": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExample", + "description": "An example of chat history and its expected outcome to be used with GenerateContent." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExampleStore": { + "description": "Represents an executable service to manage and retrieve examples.", + "id": "GoogleCloudAiplatformV1beta1ExampleStore", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this ExampleStore was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the ExampleStore.", + "type": "string" + }, + "displayName": { + "description": "Required. Display name of the ExampleStore.", + "type": "string" + }, + "exampleStoreConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ExampleStoreConfig", + "description": "Required. Example Store config." + }, + "name": { + "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this ExampleStore was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExampleStoreConfig": { + "description": "Configuration for the Example Store.", + "id": "GoogleCloudAiplatformV1beta1ExampleStoreConfig", + "properties": { + "vertexEmbeddingModel": { + "description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Examples": { "description": "Example-based explainability that returns the nearest neighbors from the provided dataset.", "id": "GoogleCloudAiplatformV1beta1Examples", @@ -27905,6 +29290,34 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ExamplesArrayFilter": { + "description": "Filters for examples' array metadata fields. An array field is example metadata where multiple values are attributed to a single example.", + "id": "GoogleCloudAiplatformV1beta1ExamplesArrayFilter", + "properties": { + "arrayOperator": { + "description": "Required. The operator logic to use for filtering.", + "enum": [ + "ARRAY_OPERATOR_UNSPECIFIED", + "CONTAINS_ANY", + "CONTAINS_ALL" + ], + "enumDescriptions": [ + "Not specified. This value should not be used.", + "The metadata array field in the example must contain at least one of the values.", + "The metadata array field in the example must contain all of the values." + ], + "type": "string" + }, + "values": { + "description": "Required. The values by which to filter examples.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ExamplesExampleGcsSource": { "description": "The Cloud Storage input instances.", "id": "GoogleCloudAiplatformV1beta1ExamplesExampleGcsSource", @@ -28818,6 +30231,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest": { + "description": "Request message for ModelGardenService.ExportPublisherModel.", + "id": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest", + "properties": { + "destination": { + "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", + "description": "Required. The target where we are exporting the model weights to" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ExportPublisherModelResponse": { "description": "Response message for ModelGardenService.ExportPublisherModel.", "id": "GoogleCloudAiplatformV1beta1ExportPublisherModelResponse", @@ -29016,6 +30440,10 @@ "description": "The fact used in grounding.", "id": "GoogleCloudAiplatformV1beta1Fact", "properties": { + "chunk": { + "$ref": "GoogleCloudAiplatformV1beta1RagChunk", + "description": "If present, chunk properties." + }, "query": { "description": "Query that is used to retrieve this fact.", "type": "string" @@ -29972,6 +31400,103 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest": { + "description": "Request message for FeatureOnlineStoreService.FeatureViewDirectWrite.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest", + "properties": { + "dataKeyAndFeatureValues": { + "description": "Required. The data keys and associated feature values.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues": { + "description": "A data key and associated feature values to write to the feature view.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues", + "properties": { + "dataKey": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey", + "description": "The data key." + }, + "features": { + "description": "List of features to write.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature": { + "description": "Feature name & value pair.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature", + "properties": { + "name": { + "description": "Feature short name.", + "type": "string" + }, + "valueAndTimestamp": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp", + "description": "Feature value and timestamp." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp": { + "description": "Feature value and timestamp.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp", + "properties": { + "timestamp": { + "description": "The feature timestamp to store with this value. If not set, then the Feature Store server will generate a timestamp when it receives the write request.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureValue", + "description": "The feature value." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse": { + "description": "Response message for FeatureOnlineStoreService.FeatureViewDirectWrite.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "Response status for the keys listed in FeatureViewDirectWriteResponse.write_responses. The error only applies to the listed data keys - the stream will remain open for further FeatureOnlineStoreService.FeatureViewDirectWriteRequest requests. Partial failures (e.g. if the first 10 keys of a request fail, but the rest succeed) from a single request may result in multiple responses - there will be one response for the successful request keys and one response for the failing request keys." + }, + "writeResponses": { + "description": "Details about write for each key. If status is not OK, WriteResponse.data_key will have the key with error, but WriteResponse.online_store_write_time will not be present.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse": { + "description": "Details about the write for each key.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse", + "properties": { + "dataKey": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey", + "description": "What key is this write response associated with." + }, + "onlineStoreWriteTime": { + "description": "When the feature values were written to the online store. If FeatureViewDirectWriteResponse.status is not OK, this field is not populated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource": { "description": "A Feature Registry source for features that need to be synced to Online Store.", "id": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource", @@ -30466,6 +31991,51 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FetchExamplesRequest": { + "description": "Request message for ExampleStoreService.FetchExamples.", + "id": "GoogleCloudAiplatformV1beta1FetchExamplesRequest", + "properties": { + "exampleIds": { + "description": "Optional. Example IDs to fetch. If both metadata filters and Example IDs are specified, then both ID and metadata filtering will be applied.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pageSize": { + "description": "Optional. The maximum number of examples to return. The service may return fewer than this value. If unspecified, at most 100 examples will be returned.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list ExampleStoreService.FetchExamplesResponse call.", + "type": "string" + }, + "storedContentsExampleFilter": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter", + "description": "The metadata filters for StoredContentsExamples." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FetchExamplesResponse": { + "description": "Response message for ExampleStoreService.FetchExamples.", + "id": "GoogleCloudAiplatformV1beta1FetchExamplesResponse", + "properties": { + "examples": { + "description": "The examples in the Example Store that satisfy the metadata filters.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Example" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as FetchExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest": { "description": "Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.", "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest", @@ -30920,9 +32490,13 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", + "description": "Optional. 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" @@ -30987,6 +32561,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" @@ -31018,7 +32596,7 @@ "id": "GoogleCloudAiplatformV1beta1GcsSource", "properties": { "uris": { - "description": "Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.", + "description": "Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.", "items": { "type": "string" }, @@ -31082,6 +32660,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig": { + "description": "Configuration for how to read Gemini requests from a multimodal dataset.", + "id": "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig", + "properties": { + "assembledRequestColumnName": { + "description": "Optional. Column name in the dataset table that contains already fully assembled Gemini requests.", + "type": "string" + }, + "templateConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GeminiTemplateConfig", + "description": "Gemini request template with placeholders." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GeminiTemplateConfig": { "description": "Template configuration to create Gemini examples from a multimodal dataset.", "id": "GoogleCloudAiplatformV1beta1GeminiTemplateConfig", @@ -31090,7 +32683,7 @@ "additionalProperties": { "type": "string" }, - "description": "Required. Map of template params to the columns in the dataset table.", + "description": "Required. Map of template parameters to the columns in the dataset table.", "type": "object" }, "geminiExample": { @@ -31355,6 +32948,21 @@ "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", "format": "int32", "type": "integer" + }, + "trafficType": { + "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "ON_DEMAND", + "PROVISIONED_THROUGHPUT" + ], + "enumDescriptions": [ + "Unspecified request traffic type.", + "Type for Pay-As-You-Go traffic.", + "Type for Provisioned Throughput traffic." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -31456,6 +33064,10 @@ ], "type": "string" }, + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", + "description": "Optional. Config for model selection." + }, "presencePenalty": { "description": "Optional. Positive penalties.", "format": "float", @@ -31517,6 +33129,10 @@ "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", @@ -31530,6 +33146,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig": { + "description": "Config for model selection.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", + "properties": { + "featureSelectionPreference": { + "description": "Required. Feature selection preference.", + "enum": [ + "FEATURE_SELECTION_PREFERENCE_UNSPECIFIED", + "PRIORITIZE_QUALITY", + "BALANCED", + "PRIORITIZE_COST" + ], + "enumDescriptions": [ + "Unspecified feature selection preference.", + "Prefer higher quality over lower cost.", + "Balanced feature selection preference.", + "Prefer lower cost over higher quality." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { "description": "The configuration for routing the request to a specific model.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", @@ -31573,12 +33212,24 @@ "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { - "description": "The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.", + "description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", "type": "string" } }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { + "description": "Config for thinking features.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", + "properties": { + "thinkingBudget": { + "description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GenericOperationMetadata": { "description": "Generic Metadata shared by all operations.", "id": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", @@ -31752,6 +33403,10 @@ "description": "Chunk from context retrieved by the retrieval tools.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", "properties": { + "ragChunk": { + "$ref": "GoogleCloudAiplatformV1beta1RagChunk", + "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." + }, "text": { "description": "Text of the attribution.", "type": "string" @@ -31771,6 +33426,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" @@ -32224,6 +33883,11 @@ "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/my_file.txt` - `gs://bucket_name/my_directory`" }, + "globalMaxEmbeddingRequestsPerMin": { + "description": "Optional. The max number of queries per minute that the indexing pipeline job is allowed to make to the embedding model specified in the project. Please follow the quota usage guideline of the embedding model you use to set the value properly.If this value is not specified, max_embedding_requests_per_min will be used by indexing pipeline job as the global limit.", + "format": "int32", + "type": "integer" + }, "googleDriveSource": { "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", "description": "Google Drive location. Supports importing individual files as well as Google Drive folders." @@ -33130,6 +34794,42 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListEventsResponse": { + "description": "Response message for SessionService.ListEvents.", + "id": "GoogleCloudAiplatformV1beta1ListEventsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as ListEventsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "type": "string" + }, + "sessionEvents": { + "description": "A list of events matching the request. Ordered by timestamp in ascending order.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListExampleStoresResponse": { + "description": "Response message for ExampleStoreService.ListExampleStores.", + "id": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse", + "properties": { + "exampleStores": { + "description": "List of ExampleStore in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListExampleStoresRequest.page_token to obtain that page.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListExecutionsResponse": { "description": "Response message for MetadataService.ListExecutions.", "id": "GoogleCloudAiplatformV1beta1ListExecutionsResponse", @@ -33797,6 +35497,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListSessionsResponse": { + "description": "Response message for SessionService.ListSessions.", + "id": "GoogleCloudAiplatformV1beta1ListSessionsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as ListSessionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "type": "string" + }, + "sessions": { + "description": "A list of sessions matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse": { "description": "Response message for SpecialistPoolService.ListSpecialistPools.", "id": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse", @@ -35862,7 +37580,7 @@ "type": "string" }, "gcsUri": { - "description": "Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.", + "description": "Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.", "type": "string" } }, @@ -36626,6 +38344,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint": { + "deprecated": true, "description": "Describes the machine learning model version checkpoint.", "id": "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint", "properties": { @@ -36638,10 +38357,6 @@ "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", @@ -37295,7 +39010,8 @@ "INVALID_SPARSE_DIMENSIONS", "INVALID_TOKEN_VALUE", "INVALID_SPARSE_EMBEDDING", - "INVALID_EMBEDDING" + "INVALID_EMBEDDING", + "INVALID_EMBEDDING_METADATA" ], "enumDescriptions": [ "Default, shall not be used.", @@ -37315,7 +39031,8 @@ "Error parsing sparse dimensions field.", "Token restrict value is invalid.", "Invalid sparse embedding.", - "Invalid dense embedding." + "Invalid dense embedding.", + "Invalid embedding metadata." ], "type": "string" }, @@ -37645,6 +39362,40 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1NotebookReservationAffinity": { + "description": "Notebook Reservation Affinity for consuming Zonal reservation.", + "id": "GoogleCloudAiplatformV1beta1NotebookReservationAffinity", + "properties": { + "consumeReservationType": { + "description": "Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples.", + "enum": [ + "RESERVATION_AFFINITY_TYPE_UNSPECIFIED", + "RESERVATION_NONE", + "RESERVATION_ANY", + "RESERVATION_SPECIFIC" + ], + "enumDescriptions": [ + "Default type.", + "Do not consume from any allocated capacity.", + "Consume any reservation available.", + "Must consume from a specific reservation. Must specify key value fields for specifying the reservations." + ], + "type": "string" + }, + "key": { + "description": "Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.", + "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1NotebookRuntime": { "description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.", "id": "GoogleCloudAiplatformV1beta1NotebookRuntime", @@ -37763,6 +39514,11 @@ "readOnly": true, "type": "string" }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookReservationAffinity", + "description": "Output only. Reservation Affinity of the notebook runtime.", + "readOnly": true + }, "runtimeState": { "description": "Output only. The runtime (instance) state of the NotebookRuntime.", "enum": [ @@ -37915,6 +39671,10 @@ ], "type": "string" }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookReservationAffinity", + "description": "Optional. Reservation Affinity of the notebook runtime template." + }, "serviceAccount": { "deprecated": true, "description": "Deprecated: This field is ignored and the \"Vertex AI Notebook Service Account\" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", @@ -38011,6 +39771,10 @@ "description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", "id": "GoogleCloudAiplatformV1beta1PairwiseMetricInstance", "properties": { + "contentMapInstance": { + "$ref": "GoogleCloudAiplatformV1beta1ContentMap", + "description": "Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content." + }, "jsonInstance": { "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", "type": "string" @@ -38022,6 +39786,11 @@ "description": "Spec for pairwise metric result.", "id": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", "properties": { + "customOutput": { + "$ref": "GoogleCloudAiplatformV1beta1CustomOutput", + "description": "Output only. Spec for custom output.", + "readOnly": true + }, "explanation": { "description": "Output only. Explanation for pairwise metric score.", "readOnly": true, @@ -38059,6 +39828,10 @@ "description": "Optional. The field name of the candidate response.", "type": "string" }, + "customOutputFormatConfig": { + "$ref": "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig", + "description": "Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty." + }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pairwise metric.", "type": "string" @@ -39085,6 +40858,10 @@ "description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", "id": "GoogleCloudAiplatformV1beta1PointwiseMetricInstance", "properties": { + "contentMapInstance": { + "$ref": "GoogleCloudAiplatformV1beta1ContentMap", + "description": "Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content." + }, "jsonInstance": { "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", "type": "string" @@ -39096,6 +40873,11 @@ "description": "Spec for pointwise metric result.", "id": "GoogleCloudAiplatformV1beta1PointwiseMetricResult", "properties": { + "customOutput": { + "$ref": "GoogleCloudAiplatformV1beta1CustomOutput", + "description": "Output only. Spec for custom output.", + "readOnly": true + }, "explanation": { "description": "Output only. Explanation for pointwise metric score.", "readOnly": true, @@ -39114,6 +40896,10 @@ "description": "Spec for pointwise metric.", "id": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", "properties": { + "customOutputFormatConfig": { + "$ref": "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig", + "description": "Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty." + }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pointwise metric.", "type": "string" @@ -39251,10 +41037,19 @@ "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination", "description": "BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging`" }, + "enableOtelLogging": { + "description": "This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.", + "type": "boolean" + }, "enabled": { "description": "If logging is enabled or not.", "type": "boolean" }, + "requestResponseLoggingSchemaVersion": { + "description": "Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are \"v1\" and \"v2\". The current default version is \"v1\".", + "readOnly": true, + "type": "string" + }, "samplingRate": { "description": "Percentage of requests to be logged, expressed as a fraction in range(0,1].", "format": "double", @@ -39481,7 +41276,7 @@ "type": "integer" }, "service": { - "description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.", + "description": "Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.", "type": "string" } }, @@ -39908,6 +41703,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PublisherModelConfig": { + "description": "This message contains configs of a publisher model.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelConfig", + "properties": { + "loggingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", + "description": "The prediction request/response logging config." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PublisherModelDocumentation": { "description": "A named piece of documentation.", "id": "GoogleCloudAiplatformV1beta1PublisherModelDocumentation", @@ -39923,6 +41729,26 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance": { + "description": "Response message for ModelGardenService.UpdatePublisherModelEula.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance", + "properties": { + "projectNumber": { + "description": "The project number requesting access for named model.", + "format": "int64", + "type": "string" + }, + "publisherModel": { + "description": "The publisher model resource name.", + "type": "string" + }, + "publisherModelEulaAcked": { + "description": "The EULA content acceptance status.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PublisherModelParent": { "description": "The information about the parent of a model.", "id": "GoogleCloudAiplatformV1beta1PublisherModelParent", @@ -40544,6 +42370,38 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagChunk": { + "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.", + "id": "GoogleCloudAiplatformV1beta1RagChunk", + "properties": { + "pageSpan": { + "$ref": "GoogleCloudAiplatformV1beta1RagChunkPageSpan", + "description": "If populated, represents where the chunk starts and ends in the document." + }, + "text": { + "description": "The content of the chunk.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagChunkPageSpan": { + "description": "Represents where the chunk starts and ends in the document.", + "id": "GoogleCloudAiplatformV1beta1RagChunkPageSpan", + "properties": { + "firstPage": { + "description": "Page where chunk starts in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" + }, + "lastPage": { + "description": "Page where chunk ends in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RagContexts": { "description": "Relevant contexts for one query.", "id": "GoogleCloudAiplatformV1beta1RagContexts", @@ -40562,6 +42420,10 @@ "description": "A context of the query.", "id": "GoogleCloudAiplatformV1beta1RagContextsContext", "properties": { + "chunk": { + "$ref": "GoogleCloudAiplatformV1beta1RagChunk", + "description": "Context of the retrieved chunk." + }, "distance": { "deprecated": true, "description": "The distance between the query dense embedding vector and the context text vector.", @@ -40738,6 +42600,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagEngineConfig": { + "description": "Config for RagEngine.", + "id": "GoogleCloudAiplatformV1beta1RagEngineConfig", + "properties": { + "name": { + "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "type": "string" + }, + "ragManagedDbConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfig", + "description": "The config of the RagManagedDb used by RagEngine." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RagFile": { "description": "A RagFile contains user data for chunking, embedding and indexing.", "id": "GoogleCloudAiplatformV1beta1RagFile", @@ -40902,6 +42779,11 @@ "description": "Document AI Layout Parser config.", "id": "GoogleCloudAiplatformV1beta1RagFileParsingConfigLayoutParser", "properties": { + "globalMaxParsingRequestsPerMin": { + "description": "The maximum number of requests the job is allowed to make to the Document AI processor per minute in this project. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline as the global limit.", + "format": "int32", + "type": "integer" + }, "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", @@ -40922,6 +42804,11 @@ "description": "The prompt to use for parsing. If not specified, a default prompt will be used.", "type": "string" }, + "globalMaxParsingRequestsPerMin": { + "description": "The maximum number of requests the job is allowed to make to the LLM model per minute in this project. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline job as the global limit.", + "format": "int32", + "type": "integer" + }, "maxParsingRequestsPerMin": { "description": "The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used.", "format": "int32", @@ -40945,6 +42832,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagManagedDbConfig": { + "description": "Configuration message for RagManagedDb used by RagEngine.", + "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfig", + "properties": { + "basic": { + "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic", + "description": "Sets the RagManagedDb to the Basic tier." + }, + "enterprise": { + "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise", + "description": "Sets the RagManagedDb to the Enterprise tier. This is the default tier if not explicitly chosen." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic": { + "description": "Basic tier is a cost-effective and low compute tier suitable for the following cases: * Experimenting with RagManagedDb. * Small data size. * Latency insensitive workload. * Only using RAG Engine with external vector DBs.", + "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise": { + "description": "Enterprise tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. NOTE: This is the default tier if not explicitly chosen.", + "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RagQuery": { "description": "A query to retrieve relevant contexts.", "id": "GoogleCloudAiplatformV1beta1RagQuery", @@ -41060,7 +42974,7 @@ "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker", "properties": { "modelName": { - "description": "Optional. The model name used for ranking. Format: `gemini-1.5-pro`", + "description": "Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", "type": "string" } }, @@ -41170,6 +43084,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RawOutput": { + "description": "Raw output.", + "id": "GoogleCloudAiplatformV1beta1RawOutput", + "properties": { + "rawOutput": { + "description": "Output only. Raw output string.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RawPredictRequest": { "description": "Request message for PredictionService.RawPredict.", "id": "GoogleCloudAiplatformV1beta1RawPredictRequest", @@ -41473,7 +43402,7 @@ }, "spec": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", - "description": "Required. Configurations of the ReasoningEngine" + "description": "Optional. Configurations of the ReasoningEngine" }, "updateTime": { "description": "Output only. Timestamp when this ReasoningEngine was most recently updated.", @@ -41489,7 +43418,7 @@ "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", "properties": { "agentFramework": { - "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"langchain\", \"langgraph\", \"ag2\", \"custom\".", + "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" }, "classMethods": { @@ -41509,7 +43438,7 @@ }, "packageSpec": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec", - "description": "Required. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes." + "description": "Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes." } }, "type": "object" @@ -41642,6 +43571,38 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1RemoveExamplesRequest": { + "description": "Request message for ExampleStoreService.RemoveExamples.", + "id": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest", + "properties": { + "exampleIds": { + "description": "Optional. Example IDs to remove. If both metadata filters and Example IDs are specified, the metadata filters will be applied to the specified examples in order to identify which should be removed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "storedContentsExampleFilter": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter", + "description": "The metadata filters for StoredContentsExamples." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RemoveExamplesResponse": { + "description": "Response message for ExampleStoreService.RemoveExamples.", + "id": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse", + "properties": { + "exampleIds": { + "description": "The IDs for the removed examples.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest": { "description": "Request message for NotebookInternalService.ReportExecutionEvent.", "id": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest", @@ -42135,6 +44096,76 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput": { + "description": "Instance and metric spec for RubricBasedInstructionFollowing metric.", + "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance", + "description": "Required. Instance for RubricBasedInstructionFollowing metric." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec", + "description": "Required. Spec for RubricBasedInstructionFollowing metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance": { + "description": "Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance", + "properties": { + "jsonInstance": { + "description": "Required. Instance specified as a json string. String key-value pairs are expected in the json_instance to render RubricBasedInstructionFollowing prompt templates.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult": { + "description": "Result for RubricBasedInstructionFollowing metric.", + "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult", + "properties": { + "rubricCritiqueResults": { + "description": "Output only. List of per rubric critique results.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RubricCritiqueResult" + }, + "readOnly": true, + "type": "array" + }, + "score": { + "description": "Output only. Overall score for the instruction following.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec": { + "description": "Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score.", + "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RubricCritiqueResult": { + "description": "Rubric critique result.", + "id": "GoogleCloudAiplatformV1beta1RubricCritiqueResult", + "properties": { + "rubric": { + "description": "Output only. Rubric to be evaluated.", + "readOnly": true, + "type": "string" + }, + "verdict": { + "description": "Output only. Verdict for the rubric - true if the rubric is met, false otherwise.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RuntimeArtifact": { "description": "The definition of a runtime artifact.", "id": "GoogleCloudAiplatformV1beta1RuntimeArtifact", @@ -42274,13 +44305,21 @@ "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true + ], "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." + "Deprecated: Election filter is not longer supported. The harm category is civic integrity." ], "readOnly": true, "type": "string" @@ -42376,13 +44415,21 @@ "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true + ], "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." + "Deprecated: Election filter is not longer supported. The harm category is civic integrity." ], "type": "string" }, @@ -42885,7 +44932,8 @@ "INTEGER", "BOOLEAN", "ARRAY", - "OBJECT" + "OBJECT", + "NULL" ], "enumDescriptions": [ "Not specified, should not be used.", @@ -42894,7 +44942,8 @@ "OpenAPI integer type", "OpenAPI boolean type", "OpenAPI array type", - "OpenAPI object type" + "OpenAPI object type", + "Null type" ], "type": "string" } @@ -47034,6 +49083,52 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SearchExamplesRequest": { + "description": "Request message for ExampleStoreService.SearchExamples.", + "id": "GoogleCloudAiplatformV1beta1SearchExamplesRequest", + "properties": { + "storedContentsExampleParameters": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleParameters", + "description": "The parameters of StoredContentsExamples to be searched." + }, + "topK": { + "description": "Optional. The number of similar examples to return.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SearchExamplesResponse": { + "description": "Response message for ExampleStoreService.SearchExamples.", + "id": "GoogleCloudAiplatformV1beta1SearchExamplesResponse", + "properties": { + "results": { + "description": "The results of searching for similar examples.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample": { + "description": "The result of the similar example.", + "id": "GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample", + "properties": { + "example": { + "$ref": "GoogleCloudAiplatformV1beta1Example", + "description": "The example that is similar to the searched query." + }, + "similarityScore": { + "description": "The similarity score of this example.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1SearchFeaturesResponse": { "description": "Response message for FeaturestoreService.SearchFeatures.", "id": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse", @@ -47359,7 +49454,7 @@ "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.", + "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.", "type": "string" }, "version": { @@ -47414,6 +49509,100 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Session": { + "description": "A session contains a set of actions between users and Vertex agents.", + "id": "GoogleCloudAiplatformV1beta1Session", + "properties": { + "createTime": { + "description": "Output only. Timestamp when the session was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the session.", + "type": "string" + }, + "name": { + "description": "Required. Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", + "type": "string" + }, + "sessionState": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Session specific memory which stores key conversation points.", + "type": "object" + }, + "updateTime": { + "description": "Output only. Timestamp when the session was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "userId": { + "description": "Required. Immutable. String id provided by the user", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SessionEvent": { + "description": "An event represents a message from either the user or agent.", + "id": "GoogleCloudAiplatformV1beta1SessionEvent", + "properties": { + "actions": { + "$ref": "GoogleCloudAiplatformV1beta1EventActions", + "description": "Optional. Actions executed by the agent." + }, + "author": { + "description": "Required. The name of the agent that sent the event, or user.", + "type": "string" + }, + "content": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Optional. Content of the event provided by the author." + }, + "errorCode": { + "description": "Optional. Error code if the response is an error. Code varies by model.", + "type": "string" + }, + "errorMessage": { + "description": "Optional. Error message if the response is an error.", + "type": "string" + }, + "eventMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1EventMetadata", + "description": "Optional. Metadata relating to this event." + }, + "invocationId": { + "description": "Required. The invocation id of the event, multiple events can have the same invocation id.", + "type": "string" + }, + "name": { + "description": "Required. Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.", + "type": "string" + }, + "timestamp": { + "description": "Required. Timestamp when the event was created on client side.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest": { + "description": "Request message for EndpointService.SetPublisherModelConfig.", + "id": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest", + "properties": { + "publisherModelConfig": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig", + "description": "Required. The publisher model config." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1SharePointSources": { "description": "The SharePointSources to pass to ImportRagFiles.", "id": "GoogleCloudAiplatformV1beta1SharePointSources", @@ -47647,6 +49836,10 @@ "description": "The speech generation config.", "id": "GoogleCloudAiplatformV1beta1SpeechConfig", "properties": { + "languageCode": { + "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", + "type": "string" + }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", "description": "The configuration for the speaker to use." @@ -47687,6 +49880,97 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1StoredContentsExample": { + "description": "A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store.", + "id": "GoogleCloudAiplatformV1beta1StoredContentsExample", + "properties": { + "contentsExample": { + "$ref": "GoogleCloudAiplatformV1beta1ContentsExample", + "description": "Required. The example to be used with GenerateContent." + }, + "searchKey": { + "description": "Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from `contents_example.contents` using the method provided by `search_key_generation_method`. The generated search key will be included in retrieved examples.", + "type": "string" + }, + "searchKeyGenerationMethod": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod", + "description": "Optional. The method used to generate the search key from `contents_example.contents`. This is ignored when uploading an example if `search_key` is provided." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter": { + "description": "The metadata filters that will be used to remove or fetch StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied.", + "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter", + "properties": { + "functionNames": { + "$ref": "GoogleCloudAiplatformV1beta1ExamplesArrayFilter", + "description": "Optional. The function names for filtering." + }, + "searchKeys": { + "description": "Optional. The search keys for filtering. Only examples with one of the specified search keys (StoredContentsExample.search_key) are eligible to be returned.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1StoredContentsExampleParameters": { + "description": "The metadata filters that will be used to search StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied", + "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleParameters", + "properties": { + "contentSearchKey": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey", + "description": "The chat history to use to generate the search key for retrieval." + }, + "functionNames": { + "$ref": "GoogleCloudAiplatformV1beta1ExamplesArrayFilter", + "description": "Optional. The function names for filtering." + }, + "searchKey": { + "description": "The exact search key to use for retrieval.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey": { + "description": "The chat history to use to generate the search key for retrieval.", + "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey", + "properties": { + "contents": { + "description": "Required. The conversation for generating a search key.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, + "searchKeyGenerationMethod": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod", + "description": "Required. The method of generating a search key." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod": { + "description": "Options for generating the search key from the conversation history.", + "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod", + "properties": { + "lastEntry": { + "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry", + "description": "Use only the last entry of the conversation history (`contents_example.contents`) as the search key." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry": { + "description": "Configuration for using only the last entry of the conversation history as the search key.", + "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1StratifiedSplit": { "description": "Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the `key` field) is mirrored within each split. The fraction values determine the relative sizes of the splits. For example, if the specified column has three values, with 50% of the rows having value \"A\", 25% value \"B\", and 25% value \"C\", and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value \"A\" for the specified column, about 25% having the value \"B\", and about 25% having the value \"C\". Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned. Supported only for tabular Datasets.", "id": "GoogleCloudAiplatformV1beta1StratifiedSplit", @@ -50703,7 +52987,7 @@ "id": "GoogleCloudAiplatformV1beta1TuningJob", "properties": { "baseModel": { - "description": "The base model that is being tuned, e.g., \"gemini-1.0-pro-002\". .", + "description": "The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).", "type": "string" }, "createTime": { @@ -51252,6 +53536,53 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1UpsertExamplesRequest": { + "description": "Request message for ExampleStoreService.UpsertExamples.", + "id": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest", + "properties": { + "examples": { + "description": "Required. A list of examples to be created/updated.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Example" + }, + "type": "array" + }, + "overwrite": { + "description": "Optional. A flag indicating whether an example can be overwritten if it already exists. If False (default) and the example already exists, the example will not be updated. This does not affect behavior if the example does not exist already.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1UpsertExamplesResponse": { + "description": "Response message for ExampleStoreService.UpsertExamples.", + "id": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse", + "properties": { + "results": { + "description": "A list of results for creating/updating. It's either a successfully created/updated example or a status with an error message.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult": { + "description": "The result for creating/updating a single example.", + "id": "GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult", + "properties": { + "example": { + "$ref": "GoogleCloudAiplatformV1beta1Example", + "description": "The example created/updated successfully." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The error message of the example that was not created/updated successfully." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1UserActionReference": { "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", "id": "GoogleCloudAiplatformV1beta1UserActionReference", diff --git a/discovery/alertcenter-v1beta1.json b/discovery/alertcenter-v1beta1.json index ca306b50d77..bf56d253bd9 100644 --- a/discovery/alertcenter-v1beta1.json +++ b/discovery/alertcenter-v1beta1.json @@ -14,7 +14,7 @@ "canonicalName": "AlertCenter", "description": "Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers. ", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/admin-sdk/alertcenter/", + "documentationLink": "https://developers.google.com/workspace/admin/alertcenter/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -243,7 +243,7 @@ "type": "string" }, "filter": { - "description": "Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.list).", + "description": "Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/workspace/admin/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/workspace/admin/alertcenter/reference/filter-fields#alerts.list).", "location": "query", "type": "string" }, @@ -356,7 +356,7 @@ "type": "string" }, "filter": { - "description": "Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).", + "description": "Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/workspace/admin/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/workspace/admin/alertcenter/reference/filter-fields#alerts.feedback.list).", "location": "query", "type": "string" } @@ -423,7 +423,7 @@ } } }, - "revision": "20241028", + "revision": "20250414", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { @@ -730,7 +730,7 @@ "type": "string" }, "type": { - "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](https://developers.google.com/admin-sdk/alertcenter/reference/alert-types).", + "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](https://developers.google.com/workspace/admin/alertcenter/reference/alert-types).", "type": "string" }, "updateTime": { @@ -856,7 +856,7 @@ "type": "object" }, "AppSettingsChanged": { - "description": "* Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the below rules. Calendar settings changed Drive settings changed Email settings changed Mobile settings changed", + "description": "Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the following rules: - Calendar settings changed - Drive settings changed - Email settings changed - Mobile settings changed", "id": "AppSettingsChanged", "properties": { "alertDetails": { @@ -1529,7 +1529,7 @@ "type": "object" }, "Notification": { - "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).", + "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/workspace/admin/alertcenter/guides/notifications).", "id": "Notification", "properties": { "cloudPubsubTopic": { @@ -1540,7 +1540,7 @@ "type": "object" }, "PhishingSpike": { - "description": "Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead.", + "description": "Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use [MailPhishing](https://developers.google.com/workspace/admin/alertcenter/reference/rest/v1beta1/MailPhishing) instead.", "id": "PhishingSpike", "properties": { "domainId": { @@ -1577,7 +1577,7 @@ "type": "object" }, "PrimaryAdminChangedEvent": { - "description": "* Event occurred when primary admin changed in customer's account. The event are being received from insight forwarder", + "description": "Event occurred when primary admin changed in customer's account. The event are being received from insight forwarder", "id": "PrimaryAdminChangedEvent", "properties": { "domain": { @@ -1756,6 +1756,7 @@ "CHROME_WARN_PAGE_PRINT", "CHROME_BLOCK_URL_VISITED", "CHROME_WARN_URL_VISITED", + "CHROME_BLOCK_SCREENSHOT", "CHROME_STORE_CONTENT", "DELETE_WEBPROTECT_EVIDENCE", "CHAT_BLOCK_CONTENT", @@ -1780,6 +1781,7 @@ "Warn user about printed page.", "Block Chrome URL visit.", "Warn user about Chrome URL visited.", + "Block screenshot alert.", "Store the content that violated the rule.", "Delete web protect evidence file", "Chat actions. Block Chat content to be sent out.", @@ -1844,6 +1846,7 @@ "CHROME_WARN_PAGE_PRINT", "CHROME_BLOCK_URL_VISITED", "CHROME_WARN_URL_VISITED", + "CHROME_BLOCK_SCREENSHOT", "CHROME_STORE_CONTENT", "DELETE_WEBPROTECT_EVIDENCE", "CHAT_BLOCK_CONTENT", @@ -1868,6 +1871,7 @@ "Warn user about printed page.", "Block Chrome URL visit.", "Warn user about Chrome URL visited.", + "Block screenshot alert.", "Store the content that violated the rule.", "Delete web protect evidence file", "Chat actions. Block Chat content to be sent out.", @@ -1888,7 +1892,7 @@ "type": "object" }, "SSOProfileCreatedEvent": { - "description": "* Event occurred when SSO Profile created in customer's account. The event are being received from insight forwarder", + "description": "Event occurred when SSO Profile created in customer's account. The event are being received from insight forwarder", "id": "SSOProfileCreatedEvent", "properties": { "inboundSsoProfileName": { @@ -1899,7 +1903,7 @@ "type": "object" }, "SSOProfileDeletedEvent": { - "description": "* Event occurred when SSO Profile deleted in customer's account. The event are being received from insight forwarder", + "description": "Event occurred when SSO Profile deleted in customer's account. The event are being received from insight forwarder", "id": "SSOProfileDeletedEvent", "properties": { "inboundSsoProfileName": { @@ -1910,7 +1914,7 @@ "type": "object" }, "SSOProfileUpdatedEvent": { - "description": "* Event occurred when SSO Profile updated in customer's account. The event are being received from insight forwarder", + "description": "Event occurred when SSO Profile updated in customer's account. The event are being received from insight forwarder", "id": "SSOProfileUpdatedEvent", "properties": { "inboundSsoProfileChanges": { @@ -2013,7 +2017,7 @@ "type": "object" }, "SuperAdminPasswordResetEvent": { - "description": "* Event occurred when password was reset for super admin in customer's account. The event are being received from insight forwarder", + "description": "Event occurred when password was reset for super admin in customer's account. The event are being received from insight forwarder", "id": "SuperAdminPasswordResetEvent", "properties": { "userEmail": { @@ -2193,7 +2197,7 @@ "type": "object" }, "UserChanges": { - "description": "* Alerts from UserChanges bucket Rules for predefined rules which contain the below rules. Suspended user made active New user Added User suspended (by admin) User granted admin privileges User admin privileges revoked User deleted Users password changed", + "description": "Alerts from UserChanges bucket Rules for predefined rules which contain the following rules: - Suspended user made active - New user added - User suspended (by admin) - User granted admin privileges - User admin privileges revoked - User deleted - Users password changed", "id": "UserChanges", "properties": { "name": { @@ -2218,6 +2222,52 @@ }, "type": "object" }, + "VaultAcceleratedDeletion": { + "description": "Alert that is triggered when a Vault accelerated deletion request is created or canceled.", + "id": "VaultAcceleratedDeletion", + "properties": { + "actionType": { + "description": "The action can be one of create and cancel", + "enum": [ + "VAULT_ACCELERATED_DELETION_ACTION_TYPE_UNSPECIFIED", + "VAULT_ACCELERATED_DELETION_ACTION_TYPE_CREATE", + "VAULT_ACCELERATED_DELETION_ACTION_TYPE_CANCEL" + ], + "enumDescriptions": [ + "Unspecified action type", + "AD Create action type", + "AD Cancel action type" + ], + "type": "string" + }, + "appType": { + "description": "Currentlty only Gmail is supported as app type", + "enum": [ + "VAULT_ACCELERATED_DELETION_APP_TYPE_UNSPECIFIED", + "VAULT_ACCELERATED_DELETION_APP_TYPE_GMAIL" + ], + "enumDescriptions": [ + "Unspecified app type", + "Gmail app type" + ], + "type": "string" + }, + "createTime": { + "description": "The UTC timestamp of when the AD request was created", + "format": "google-datetime", + "type": "string" + }, + "deletionRequestId": { + "description": "Accelerated deletion request ID intended to be used to construct the Vault UI link to the AD request", + "type": "string" + }, + "matterId": { + "description": "Matter ID of the accelerated deletion request intended to be used to construct the Vault UI link to the AD request", + "type": "string" + } + }, + "type": "object" + }, "VoiceMisconfiguration": { "description": "An alert triggered when Google Voice configuration becomes invalid, generally due to an external entity being modified or deleted.", "id": "VoiceMisconfiguration", diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 4a884d119fb..42d83df666d 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1616,7 +1622,7 @@ } } }, - "revision": "20250308", + "revision": "20250410", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1693,6 +1699,12 @@ "readOnly": true, "type": "string" }, + "createCompletionTime": { + "description": "Output only. Timestamp when the resource finished being created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Create time stamp", "format": "google-datetime", @@ -1839,7 +1851,7 @@ "type": "string" }, "updateTime": { - "description": "Output only. Update time stamp", + "description": "Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3472,7 +3484,7 @@ "type": "string" }, "consumerNetworkStatus": { - "description": "Output only. The status of the service connection policy.", + "description": "Output only. The status of the service connection policy. Possible values: \"STATE_UNSPECIFIED\" - Default state, when Connection Map is created initially. \"VALID\" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. \"CONNECTION_POLICY_MISSING\" - No Service Connection Policy found for this network and Service Class \"POLICY_LIMIT_REACHED\" - Service Connection Policy limit reached for this network and Service Class \"CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED\" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.", "readOnly": true, "type": "string" }, @@ -3486,7 +3498,7 @@ "type": "string" }, "status": { - "description": "Output only. The status of the PSC service automation connection.", + "description": "Output only. The status of the PSC service automation connection. Possible values: \"STATE_UNSPECIFIED\" - An invalid state as the default case. \"ACTIVE\" - The connection has been created successfully. \"FAILED\" - The connection is not functional since some resources on the connection fail to be created. \"CREATING\" - The connection is being created. \"DELETING\" - The connection is being deleted. \"CREATE_REPAIRING\" - The connection is being repaired to complete creation. \"DELETE_REPAIRING\" - The connection is being repaired to complete deletion.", "readOnly": true, "type": "string" } @@ -3660,7 +3672,7 @@ "type": "object" }, "RestoreClusterRequest": { - "description": "Message for restoring a Cluster from a backup or another cluster at a given point in time.", + "description": "Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11", "id": "RestoreClusterRequest", "properties": { "backupSource": { diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 76765bac277..0cd1bec658f 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1616,7 +1622,7 @@ } } }, - "revision": "20250308", + "revision": "20250410", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1693,6 +1699,12 @@ "readOnly": true, "type": "string" }, + "createCompletionTime": { + "description": "Output only. Timestamp when the resource finished being created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Create time stamp", "format": "google-datetime", @@ -1844,7 +1856,7 @@ "type": "string" }, "updateTime": { - "description": "Output only. Update time stamp", + "description": "Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2045,7 +2057,8 @@ }, "geminiConfig": { "$ref": "GeminiClusterConfig", - "description": "Optional. Configuration parameters related to the Gemini in Databases add-on." + "deprecated": true, + "description": "Optional. Deprecated and unused. This field will be removed in the near future." }, "initialUser": { "$ref": "UserPassword", @@ -2315,6 +2328,80 @@ }, "type": "object" }, + "ConnectionPoolConfig": { + "description": "Configuration for Managed Connection Pool (MCP).", + "id": "ConnectionPoolConfig", + "properties": { + "defaultPoolSize": { + "description": "Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20.", + "type": "string" + }, + "enable": { + "description": "Optional. Deprecated; Prefer 'enabled' as this will be removed soon.", + "type": "boolean" + }, + "enabled": { + "description": "Optional. Whether to enable Managed Connection Pool (MCP).", + "type": "boolean" + }, + "flags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Connection Pool flags, as a list of \"key\": \"value\" pairs.", + "type": "object" + }, + "ignoreStartupParameters": { + "description": "Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to [\"extra_float_digits\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "maxClientConn": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed.", + "type": "string" + }, + "maxPreparedStatements": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0.", + "type": "string" + }, + "minPoolSize": { + "description": "Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0.", + "type": "string" + }, + "poolMode": { + "description": "Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`.", + "enum": [ + "POOL_MODE_UNSPECIFIED", + "POOL_MODE_SESSION", + "POOL_MODE_TRANSACTION" + ], + "enumDescriptions": [ + "The pool mode is not specified. Defaults to `POOL_MODE_TRANSACTION`.", + "Server is released back to pool after a client disconnects.", + "Server is released back to pool after a transaction finishes." + ], + "type": "string" + }, + "queryWaitTimeout": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables.", + "type": "string" + }, + "serverIdleTimeout": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables.", + "type": "string" + }, + "statsUsers": { + "description": "Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ContinuousBackupConfig": { "description": "ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.", "id": "ContinuousBackupConfig", @@ -2592,11 +2679,12 @@ "type": "object" }, "GeminiClusterConfig": { - "description": "Cluster level configuration parameters related to the Gemini in Databases add-on.", + "description": "Deprecated and unused. This field will be removed in the near future.", "id": "GeminiClusterConfig", "properties": { "entitled": { - "description": "Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", + "deprecated": true, + "description": "Output only. Deprecated and unused. This field will be removed in the near future.", "readOnly": true, "type": "boolean" } @@ -2604,11 +2692,12 @@ "type": "object" }, "GeminiInstanceConfig": { - "description": "Instance level configuration parameters related to the Gemini in Databases add-on.", + "description": "Deprecated and unused. This field will be removed in the near future.", "id": "GeminiInstanceConfig", "properties": { "entitled": { - "description": "Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", + "deprecated": true, + "description": "Output only. Deprecated and unused. This field will be removed in the near future.", "readOnly": true, "type": "boolean" } @@ -2799,6 +2888,10 @@ "$ref": "ClientConnectionConfig", "description": "Optional. Client connection specific configurations" }, + "connectionPoolConfig": { + "$ref": "ConnectionPoolConfig", + "description": "Optional. The configuration for Managed Connection Pool (MCP)." + }, "createTime": { "description": "Output only. Create time stamp", "format": "google-datetime", @@ -2837,7 +2930,8 @@ }, "geminiConfig": { "$ref": "GeminiInstanceConfig", - "description": "Optional. Configuration parameters related to the Gemini in Databases add-on." + "deprecated": true, + "description": "Optional. Deprecated and unused. This field will be removed in the near future." }, "instanceType": { "description": "Required. The type of the instance. Specified at creation time.", @@ -3543,7 +3637,7 @@ "type": "string" }, "consumerNetworkStatus": { - "description": "Output only. The status of the service connection policy.", + "description": "Output only. The status of the service connection policy. Possible values: \"STATE_UNSPECIFIED\" - Default state, when Connection Map is created initially. \"VALID\" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. \"CONNECTION_POLICY_MISSING\" - No Service Connection Policy found for this network and Service Class \"POLICY_LIMIT_REACHED\" - Service Connection Policy limit reached for this network and Service Class \"CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED\" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.", "readOnly": true, "type": "string" }, @@ -3557,7 +3651,7 @@ "type": "string" }, "status": { - "description": "Output only. The status of the PSC service automation connection.", + "description": "Output only. The status of the PSC service automation connection. Possible values: \"STATE_UNSPECIFIED\" - An invalid state as the default case. \"ACTIVE\" - The connection has been created successfully. \"FAILED\" - The connection is not functional since some resources on the connection fail to be created. \"CREATING\" - The connection is being created. \"DELETING\" - The connection is being deleted. \"CREATE_REPAIRING\" - The connection is being repaired to complete creation. \"DELETE_REPAIRING\" - The connection is being repaired to complete deletion.", "readOnly": true, "type": "string" } @@ -3731,7 +3825,7 @@ "type": "object" }, "RestoreClusterRequest": { - "description": "Message for restoring a Cluster from a backup or another cluster at a given point in time.", + "description": "Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11", "id": "RestoreClusterRequest", "properties": { "backupSource": { diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 760bcb6d386..63443e296f0 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1613,7 +1619,7 @@ } } }, - "revision": "20250308", + "revision": "20250410", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1690,6 +1696,12 @@ "readOnly": true, "type": "string" }, + "createCompletionTime": { + "description": "Output only. Timestamp when the resource finished being created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Create time stamp", "format": "google-datetime", @@ -1836,7 +1848,7 @@ "type": "string" }, "updateTime": { - "description": "Output only. Update time stamp", + "description": "Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2031,7 +2043,8 @@ }, "geminiConfig": { "$ref": "GeminiClusterConfig", - "description": "Optional. Configuration parameters related to the Gemini in Databases add-on." + "deprecated": true, + "description": "Optional. Deprecated and unused. This field will be removed in the near future." }, "initialUser": { "$ref": "UserPassword", @@ -2296,6 +2309,80 @@ }, "type": "object" }, + "ConnectionPoolConfig": { + "description": "Configuration for Managed Connection Pool (MCP).", + "id": "ConnectionPoolConfig", + "properties": { + "defaultPoolSize": { + "description": "Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20.", + "type": "string" + }, + "enable": { + "description": "Optional. Deprecated; Prefer 'enabled' as this will be removed soon.", + "type": "boolean" + }, + "enabled": { + "description": "Optional. Whether to enable Managed Connection Pool (MCP).", + "type": "boolean" + }, + "flags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Connection Pool flags, as a list of \"key\": \"value\" pairs.", + "type": "object" + }, + "ignoreStartupParameters": { + "description": "Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to [\"extra_float_digits\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "maxClientConn": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed.", + "type": "string" + }, + "maxPreparedStatements": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0.", + "type": "string" + }, + "minPoolSize": { + "description": "Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0.", + "type": "string" + }, + "poolMode": { + "description": "Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`.", + "enum": [ + "POOL_MODE_UNSPECIFIED", + "POOL_MODE_SESSION", + "POOL_MODE_TRANSACTION" + ], + "enumDescriptions": [ + "The pool mode is not specified. Defaults to `POOL_MODE_TRANSACTION`.", + "Server is released back to pool after a client disconnects.", + "Server is released back to pool after a transaction finishes." + ], + "type": "string" + }, + "queryWaitTimeout": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables.", + "type": "string" + }, + "serverIdleTimeout": { + "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables.", + "type": "string" + }, + "statsUsers": { + "description": "Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ContinuousBackupConfig": { "description": "ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.", "id": "ContinuousBackupConfig", @@ -2573,11 +2660,12 @@ "type": "object" }, "GeminiClusterConfig": { - "description": "Cluster level configuration parameters related to the Gemini in Databases add-on.", + "description": "Deprecated and unused. This field will be removed in the near future.", "id": "GeminiClusterConfig", "properties": { "entitled": { - "description": "Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", + "deprecated": true, + "description": "Output only. Deprecated and unused. This field will be removed in the near future.", "readOnly": true, "type": "boolean" } @@ -2585,11 +2673,12 @@ "type": "object" }, "GeminiInstanceConfig": { - "description": "Instance level configuration parameters related to the Gemini in Databases add-on.", + "description": "Deprecated and unused. This field will be removed in the near future.", "id": "GeminiInstanceConfig", "properties": { "entitled": { - "description": "Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", + "deprecated": true, + "description": "Output only. Deprecated and unused. This field will be removed in the near future.", "readOnly": true, "type": "boolean" } @@ -2780,6 +2869,10 @@ "$ref": "ClientConnectionConfig", "description": "Optional. Client connection specific configurations" }, + "connectionPoolConfig": { + "$ref": "ConnectionPoolConfig", + "description": "Optional. The configuration for Managed Connection Pool (MCP)." + }, "createTime": { "description": "Output only. Create time stamp", "format": "google-datetime", @@ -2818,7 +2911,8 @@ }, "geminiConfig": { "$ref": "GeminiInstanceConfig", - "description": "Optional. Configuration parameters related to the Gemini in Databases add-on." + "deprecated": true, + "description": "Optional. Deprecated and unused. This field will be removed in the near future." }, "instanceType": { "description": "Required. The type of the instance. Specified at creation time.", @@ -3519,7 +3613,7 @@ "type": "string" }, "consumerNetworkStatus": { - "description": "Output only. The status of the service connection policy.", + "description": "Output only. The status of the service connection policy. Possible values: \"STATE_UNSPECIFIED\" - Default state, when Connection Map is created initially. \"VALID\" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. \"CONNECTION_POLICY_MISSING\" - No Service Connection Policy found for this network and Service Class \"POLICY_LIMIT_REACHED\" - Service Connection Policy limit reached for this network and Service Class \"CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED\" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.", "readOnly": true, "type": "string" }, @@ -3533,7 +3627,7 @@ "type": "string" }, "status": { - "description": "Output only. The status of the PSC service automation connection.", + "description": "Output only. The status of the PSC service automation connection. Possible values: \"STATE_UNSPECIFIED\" - An invalid state as the default case. \"ACTIVE\" - The connection has been created successfully. \"FAILED\" - The connection is not functional since some resources on the connection fail to be created. \"CREATING\" - The connection is being created. \"DELETING\" - The connection is being deleted. \"CREATE_REPAIRING\" - The connection is being repaired to complete creation. \"DELETE_REPAIRING\" - The connection is being repaired to complete deletion.", "readOnly": true, "type": "string" } @@ -3707,7 +3801,7 @@ "type": "object" }, "RestoreClusterRequest": { - "description": "Message for restoring a Cluster from a backup or another cluster at a given point in time.", + "description": "Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11", "id": "RestoreClusterRequest", "properties": { "backupSource": { diff --git a/discovery/analyticsadmin-v1alpha.json b/discovery/analyticsadmin-v1alpha.json index a31c32eea10..a9a436d65fb 100644 --- a/discovery/analyticsadmin-v1alpha.json +++ b/discovery/analyticsadmin-v1alpha.json @@ -4455,6 +4455,165 @@ } } }, + "reportingDataAnnotations": { + "methods": { + "create": { + "description": "Creates a Reporting Data Annotation.", + "flatPath": "v1alpha/properties/{propertiesId}/reportingDataAnnotations", + "httpMethod": "POST", + "id": "analyticsadmin.properties.reportingDataAnnotations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The property for which to create a Reporting Data Annotation. Format: properties/property_id Example: properties/123", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/reportingDataAnnotations", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a Reporting Data Annotation.", + "flatPath": "v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.reportingDataAnnotations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the Reporting Data Annotation to delete. Format: properties/property_id/reportingDataAnnotations/reporting_data_annotation Example: properties/123/reportingDataAnnotations/456", + "location": "path", + "pattern": "^properties/[^/]+/reportingDataAnnotations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup a single Reporting Data Annotation.", + "flatPath": "v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.reportingDataAnnotations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the Reporting Data Annotation to lookup. Format: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Example: properties/123/reportingDataAnnotations/456", + "location": "path", + "pattern": "^properties/[^/]+/reportingDataAnnotations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "List all Reporting Data Annotations on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/reportingDataAnnotations", + "httpMethod": "GET", + "id": "analyticsadmin.properties.reportingDataAnnotations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: * 'name' * `title` * `description` * `annotation_date` * `annotation_date_range` * `color` Additionally, this API provides the following helper functions: * annotation_duration() : the duration that this annotation marks, [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto). expect a numeric representation of seconds followed by an `s` suffix. * is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the `start_date` and `end_date`. The dates are in ISO-8601 format, for example `2031-06-28`. Supported operations: * `=` : equals * `!=` : not equals * `<` : less than * `>` : greater than * `<=` : less than or equals * `>=` : greater than or equals * `:` : has operator * `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax) match * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax) does not match * `NOT` : Logical not * `AND` : Logical and * `OR` : Logical or Examples: 1. `title=\"Holiday Sale\"` 2. `description=~\"[Bb]ig [Gg]ame.*[Ss]ale\"` 3. `is_annotation_in_range(\"2025-12-25\", \"2026-01-16\") = true` 4. `annotation_duration() >= 172800s AND title:BOGO`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListReportingDataAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReportingDataAnnotations` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the property. Format: properties/property_id Example: properties/123", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/reportingDataAnnotations", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a Reporting Data Annotation.", + "flatPath": "v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.reportingDataAnnotations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'", + "location": "path", + "pattern": "^properties/[^/]+/reportingDataAnnotations/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, "rollupPropertySourceLinks": { "methods": { "create": { @@ -4886,7 +5045,7 @@ } } }, - "revision": "20250307", + "revision": "20250329", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -6270,6 +6429,10 @@ "$ref": "GoogleAnalyticsAdminV1alphaProperty", "description": "A snapshot of a Property resource in change history." }, + "reportingDataAnnotation": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation", + "description": "A snapshot of a ReportingDataAnnotation resource in change history." + }, "searchAds360Link": { "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link", "description": "A snapshot of a SearchAds360Link resource in change history." @@ -8117,6 +8280,24 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse": { + "description": "Response message for ListReportingDataAnnotation RPC.", + "id": "GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse", + "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" + }, + "reportingDataAnnotations": { + "description": "List of Reporting Data Annotations.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse": { "description": "Response message for ListRollupPropertySourceLinks RPC.", "id": "GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse", @@ -8571,6 +8752,77 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaReportingDataAnnotation": { + "description": "A Reporting Data Annotation is a comment connected to certain dates for reporting data.", + "id": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation", + "properties": { + "annotationDate": { + "$ref": "GoogleTypeDate", + "description": "If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future." + }, + "annotationDateRange": { + "$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange", + "description": "If set, the Reporting Data Annotation is for a range of dates represented by this field." + }, + "color": { + "description": "Required. The color used for display of this Reporting Data Annotation.", + "enum": [ + "COLOR_UNSPECIFIED", + "PURPLE", + "BROWN", + "BLUE", + "GREEN", + "RED", + "CYAN", + "ORANGE" + ], + "enumDescriptions": [ + "Color unknown or not specified.", + "Purple color.", + "Brown color.", + "Blue color.", + "Green color.", + "Red color.", + "Cyan color.", + "Orange color. (Only used for system-generated annotations)" + ], + "type": "string" + }, + "description": { + "description": "Optional. Description for this Reporting Data Annotation.", + "type": "string" + }, + "name": { + "description": "Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'", + "type": "string" + }, + "systemGenerated": { + "description": "Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.", + "readOnly": true, + "type": "boolean" + }, + "title": { + "description": "Required. Human-readable title for this Reporting Data Annotation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange": { + "description": "Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property.", + "id": "GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange", + "properties": { + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date." + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future." + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink": { "description": "A link that references a source property under the parent rollup property.", "id": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink", @@ -8841,7 +9093,8 @@ "AUDIENCE", "EVENT_CREATE_RULE", "KEY_EVENT", - "CALCULATED_METRIC" + "CALCULATED_METRIC", + "REPORTING_DATA_ANNOTATION" ], "enumDescriptions": [ "Resource type unknown or not specified.", @@ -8870,7 +9123,8 @@ "Audience resource", "EventCreateRule resource", "KeyEvent resource", - "CalculatedMetric resource" + "CalculatedMetric resource", + "ReportingDataAnnotation resource" ], "type": "string" }, @@ -9071,6 +9325,28 @@ "id": "GoogleProtobufEmpty", "properties": {}, "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" } }, "servicePath": "", diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 4e7e1c022e3..210dba5bc49 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -173,7 +173,7 @@ ], "parameters": { "dataExchangeId": { - "description": "Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.", + "description": "Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.", "location": "query", "type": "string" }, @@ -493,7 +493,7 @@ ], "parameters": { "listingId": { - "description": "Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.", + "description": "Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.", "location": "query", "type": "string" }, @@ -1027,24 +1027,9 @@ } } }, - "revision": "20250310", + "revision": "20250418", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { - "AnalyticsHubSubscriptionInfo": { - "description": "Information about an associated [Analytics Hub subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).", - "id": "AnalyticsHubSubscriptionInfo", - "properties": { - "listing": { - "description": "Optional. The name of the associated Analytics Hub listing resource. Pattern: \"projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}\"", - "type": "string" - }, - "subscription": { - "description": "Optional. The name of the associated Analytics Hub subscription resource. Pattern: \"projects/{project}/locations/{location}/subscriptions/{subscription}\"", - "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", @@ -1120,27 +1105,6 @@ "description": "Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", "type": "string" }, - "state": { - "description": "Output only. An output-only field that indicates whether or not the subscription can receive messages.", - "enum": [ - "STATE_UNSPECIFIED", - "ACTIVE", - "PERMISSION_DENIED", - "NOT_FOUND", - "SCHEMA_MISMATCH", - "IN_TRANSIT_LOCATION_RESTRICTION" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The subscription can actively send messages to BigQuery", - "Cannot write to the BigQuery table because of permission denied errors. This can happen if - Pub/Sub SA has not been granted the [appropriate BigQuery IAM permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account) - bigquery.googleapis.com API is not enabled for the project ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))", - "Cannot write to the BigQuery table because it does not exist.", - "Cannot write to the BigQuery table due to a schema mismatch.", - "Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions." - ], - "readOnly": true, - "type": "string" - }, "table": { "description": "Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}", "type": "string" @@ -1234,7 +1198,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 acknowledgment deadline.", + "description": "Optional. File batching settings. If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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.", "format": "google-duration", "type": "string" }, @@ -1247,27 +1211,6 @@ "description": "Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", "type": "string" }, - "state": { - "description": "Output only. An output-only field that indicates whether or not the subscription can receive messages.", - "enum": [ - "STATE_UNSPECIFIED", - "ACTIVE", - "PERMISSION_DENIED", - "NOT_FOUND", - "IN_TRANSIT_LOCATION_RESTRICTION", - "SCHEMA_MISMATCH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The subscription can actively send messages to Cloud Storage.", - "Cannot write to the Cloud Storage bucket because of permission denied errors.", - "Cannot write to the Cloud Storage bucket because it does not exist.", - "Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.", - "Cannot write to the Cloud Storage bucket due to an incompatibility between the topic schema and subscription settings." - ], - "readOnly": true, - "type": "string" - }, "textConfig": { "$ref": "TextConfig", "description": "Optional. If set, message data will be written to Cloud Storage in text format." @@ -1377,7 +1320,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 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.", + "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.", "format": "int32", "type": "integer" } @@ -1416,6 +1359,13 @@ "location": { "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" + }, + "replicaLocations": { + "description": "Optional. The geographic locations where the dataset should be replicated. See https://cloud.google.com/bigquery/docs/locations for supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -1572,7 +1522,7 @@ "type": "object" }, "GooglePubsubV1Subscription": { - "description": "A subscription resource. If none of `push_config`, `bigquery_config`, or `cloud_storage_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.", + "description": "Defines the destination Pub/Sub subscription. If none of `push_config`, `bigquery_config`, `cloud_storage_config`, `pubsub_export_config`, or `pubsublite_export_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.", "id": "GooglePubsubV1Subscription", "properties": { "ackDeadlineSeconds": { @@ -1580,11 +1530,6 @@ "format": "int32", "type": "integer" }, - "analyticsHubSubscriptionInfo": { - "$ref": "AnalyticsHubSubscriptionInfo", - "description": "Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.", - "readOnly": true - }, "bigqueryConfig": { "$ref": "BigQueryConfig", "description": "Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it." @@ -1602,7 +1547,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 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.", + "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.", "type": "boolean" }, "enableMessageOrdering": { @@ -1650,28 +1595,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 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.", - "enum": [ - "STATE_UNSPECIFIED", - "ACTIVE", - "RESOURCE_ERROR" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The subscription can actively receive messages", - "The subscription cannot receive messages because of an error with the resource to which it pushes messages. See the more detailed error state in the corresponding configuration." - ], - "readOnly": true, - "type": "string" - }, - "topicMessageRetentionDuration": { - "description": "Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.", - "format": "google-duration", - "readOnly": true, - "type": "string" + "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." } }, "type": "object" @@ -1807,6 +1731,10 @@ "description": "A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.", "id": "Listing", "properties": { + "allowOnlyMetadataSharing": { + "description": "Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.", + "type": "boolean" + }, "bigqueryDataset": { "$ref": "BigQueryDatasetSource", "description": "Shared dataset i.e. BigQuery dataset source." @@ -2123,7 +2051,7 @@ "id": "PubSubTopicSource", "properties": { "dataAffinityRegions": { - "description": "Optional. Region hint on where the data might be published. Data affinity regions are modifiable. See go/regions for full listing of possible Cloud regions.", + "description": "Optional. Region hint on where the data might be published. Data affinity regions are modifiable. See https://cloud.google.com/about/locations for full listing of possible Cloud regions.", "items": { "type": "string" }, @@ -2244,7 +2172,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 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.", + "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.", "id": "RetryPolicy", "properties": { "maximumBackoff": { diff --git a/discovery/analyticshub-v1beta1.json b/discovery/analyticshub-v1beta1.json index d87a4f6a8c9..ad520e54f73 100644 --- a/discovery/analyticshub-v1beta1.json +++ b/discovery/analyticshub-v1beta1.json @@ -695,7 +695,7 @@ } } }, - "revision": "20250217", + "revision": "20250418", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1032,6 +1032,10 @@ "description": "A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.", "id": "Listing", "properties": { + "allowOnlyMetadataSharing": { + "description": "Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.", + "type": "boolean" + }, "bigqueryDataset": { "$ref": "BigQueryDatasetSource", "description": "Required. Shared dataset i.e. BigQuery dataset source." diff --git a/discovery/androiddeviceprovisioning-v1.json b/discovery/androiddeviceprovisioning-v1.json index 7ca41aac66a..a6910dc3198 100644 --- a/discovery/androiddeviceprovisioning-v1.json +++ b/discovery/androiddeviceprovisioning-v1.json @@ -851,7 +851,7 @@ } } }, - "revision": "20241202", + "revision": "20250331", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { @@ -1434,7 +1434,7 @@ "properties": { "deviceIdentifier": { "$ref": "DeviceIdentifier", - "description": "Required. Required. The device identifier to search for." + "description": "Required. Required. The device identifier to search for. If serial number is provided then case insensitive serial number matches are allowed." }, "limit": { "description": "Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.", diff --git a/discovery/androidenterprise-v1.json b/discovery/androidenterprise-v1.json index 52b5ba1f77d..4759a765d36 100644 --- a/discovery/androidenterprise-v1.json +++ b/discovery/androidenterprise-v1.json @@ -560,7 +560,7 @@ ] }, "getServiceAccount": { - "description": "Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.", + "description": "Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource. *Note:* After you create a key, you might need to wait for 60 seconds or more before you perform another operation with the key. If you try to perform an operation with the key immediately after you create the key, and you receive an error, you can retry the request with exponential backoff .", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccount", "httpMethod": "GET", "id": "androidenterprise.enterprises.getServiceAccount", @@ -2691,7 +2691,7 @@ } } }, - "revision": "20250302", + "revision": "20250330", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -3431,7 +3431,7 @@ "type": "object" }, "EnterpriseUpgradeEvent": { - "description": "An event generated when an enterprise is upgraded. **Note:** This feature is not generally available.", + "description": "An event generated when an enterprise is upgraded.", "id": "EnterpriseUpgradeEvent", "properties": { "upgradeState": { @@ -4010,7 +4010,7 @@ }, "enterpriseUpgradeEvent": { "$ref": "EnterpriseUpgradeEvent", - "description": "Notifications about enterprise upgrade. **Note:** This feature is not generally available." + "description": "Notifications about enterprise upgrade." }, "installFailureEvent": { "$ref": "InstallFailureEvent", @@ -4050,7 +4050,7 @@ "Notification about product availability change.", "Notification about a new device.", "Notification about an updated device report.", - "Notification about an enterprise upgrade. **Note:** This feature is not generally available." + "Notification about an enterprise upgrade." ], "type": "string" }, diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index d06122cb9d3..59ddec9b5b9 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -1010,7 +1010,7 @@ ], "parameters": { "name": { - "description": "The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}.", + "description": "The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.", "location": "path", "pattern": "^enterprises/[^/]+/webApps/[^/]+$", "required": true, @@ -1202,7 +1202,7 @@ } } }, - "revision": "20250306", + "revision": "20250428", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2000,6 +2000,36 @@ }, "type": "object" }, + "BackupServiceToggledEvent": { + "description": "An admin has enabled or disabled backup service.", + "id": "BackupServiceToggledEvent", + "properties": { + "adminPackageName": { + "description": "Package name of the admin app requesting the change.", + "type": "string" + }, + "adminUserId": { + "description": "User ID of the admin app from the which the change was requested.", + "format": "int32", + "type": "integer" + }, + "backupServiceState": { + "description": "Whether the backup service is enabled", + "enum": [ + "BACKUP_SERVICE_STATE_UNSPECIFIED", + "BACKUP_SERVICE_DISABLED", + "BACKUP_SERVICE_ENABLED" + ], + "enumDescriptions": [ + "No value is set", + "Backup service is enabled", + "Backup service is disabled" + ], + "type": "string" + } + }, + "type": "object" + }, "BatchUsageLogEvents": { "description": "Batched event logs of events from the device.", "id": "BatchUsageLogEvents", @@ -2767,6 +2797,20 @@ "description": "Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.", "id": "DeviceConnectivityManagement", "properties": { + "bluetoothSharing": { + "description": "Optional. Controls whether Bluetooth sharing is allowed.", + "enum": [ + "BLUETOOTH_SHARING_UNSPECIFIED", + "BLUETOOTH_SHARING_ALLOWED", + "BLUETOOTH_SHARING_DISALLOWED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to BLUETOOTH_SHARING_DISALLOWED on work profiles and BLUETOOTH_SHARING_ALLOWED on fully managed devices.", + "Bluetooth sharing is allowed.Supported on Android 8 and above. A NonComplianceDetail with API_LEVEL is reported on work profiles if the Android version is less than 8.", + "Bluetooth sharing is disallowed.Supported on Android 8 and above. A NonComplianceDetail with API_LEVEL is reported on fully managed devices if the Android version is less than 8." + ], + "type": "string" + }, "configureWifi": { "description": "Controls Wi-Fi configuring privileges. Based on the option set, user will have either full or limited or no control in configuring Wi-Fi networks.", "enum": [ @@ -3204,7 +3248,7 @@ "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 an enterprise is upgraded.Note: This feature is not generally available." + "A notification sent for an enterprise upgrade. An enterprise upgrade is a process that upgrades a managed Google Play Accounts enterprise to a managed Google domain." ], "type": "string" }, @@ -3297,6 +3341,30 @@ }, "type": "object" }, + "EnterpriseUpgradeEvent": { + "description": "An event sent for an enterprise upgrade. An enterprise upgrade is a process that upgrades a managed Google Play Accounts enterprise to a managed Google domain.", + "id": "EnterpriseUpgradeEvent", + "properties": { + "enterprise": { + "description": "The name of upgraded enterprise in the format \"enterprises/{enterprise}\"", + "type": "string" + }, + "upgradeState": { + "description": "Output only. The upgrade state of the enterprise.", + "enum": [ + "UPGRADE_STATE_UNSPECIFIED", + "UPGRADE_STATE_SUCCEEDED" + ], + "enumDescriptions": [ + "Unspecified. This value is not used.", + "The upgrade has succeeded." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ExtensionConfig": { "description": "Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above.", "id": "ExtensionConfig", @@ -4888,6 +4956,20 @@ }, "type": "array" }, + "bluetoothSharing": { + "description": "Optional. Whether bluetooth sharing is allowed.", + "enum": [ + "BLUETOOTH_SHARING_UNSPECIFIED", + "BLUETOOTH_SHARING_ALLOWED", + "BLUETOOTH_SHARING_DISALLOWED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to BLUETOOTH_SHARING_ALLOWED.", + "Bluetooth sharing is allowed on personal profile.Supported on Android 8 and above. A NonComplianceDetail with MANAGEMENT_MODE is reported if this is set for a personal device.", + "Bluetooth sharing is disallowed on personal profile.Supported on Android 8 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 8. A NonComplianceDetail with MANAGEMENT_MODE is reported if this is set for a personal device." + ], + "type": "string" + }, "cameraDisabled": { "description": "If true, the camera is disabled on the personal profile.", "type": "boolean" @@ -6385,6 +6467,10 @@ "$ref": "AppProcessStartEvent", "description": "An app process was started. Part of SECURITY_LOGS." }, + "backupServiceToggledEvent": { + "$ref": "BackupServiceToggledEvent", + "description": "An admin has enabled or disabled backup service. Part of SECURITY_LOGS." + }, "certAuthorityInstalledEvent": { "$ref": "CertAuthorityInstalledEvent", "description": "A new root certificate was installed into the system's trusted credential storage. Part of SECURITY_LOGS." @@ -6457,7 +6543,8 @@ "STOP_LOST_MODE_USER_ATTEMPT", "LOST_MODE_OUTGOING_PHONE_CALL", "LOST_MODE_LOCATION", - "ENROLLMENT_COMPLETE" + "ENROLLMENT_COMPLETE", + "BACKUP_SERVICE_TOGGLED" ], "enumDescriptions": [ "This value is not used", @@ -6491,7 +6578,8 @@ "Indicates stopLostModeUserAttemptEvent has been set.", "Indicates lostModeOutgoingPhoneCallEvent has been set.", "Indicates lostModeLocationEvent has been set.", - "Indicates enrollment_complete_event has been set." + "Indicates enrollment_complete_event has been set.", + "Indicates backupServiceToggledEvent has been set." ], "type": "string" }, diff --git a/discovery/apigateway-v1.json b/discovery/apigateway-v1.json index bb976c97298..fbadaaded94 100644 --- a/discovery/apigateway-v1.json +++ b/discovery/apigateway-v1.json @@ -142,6 +142,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1083,7 +1089,7 @@ } } }, - "revision": "20241204", + "revision": "20250409", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/discovery/apigateway-v1beta.json b/discovery/apigateway-v1beta.json index 589f28f2b08..1787d4631e9 100644 --- a/discovery/apigateway-v1beta.json +++ b/discovery/apigateway-v1beta.json @@ -142,6 +142,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1083,7 +1089,7 @@ } } }, - "revision": "20241204", + "revision": "20250409", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 1eedf79945e..0e4fccb203b 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -6176,7 +6176,7 @@ ] }, "update": { - "description": "Updates the certificate in an alias.", + "description": "Updates the certificate in an alias. The updated certificate must be in PEM- or DER-encoded X.509 format.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}", "httpMethod": "PUT", "id": "apigee.organizations.environments.keystores.aliases.update", @@ -6449,7 +6449,7 @@ "type": "string" }, "limit": { - "description": "Maximum number of result items to return. The default and maximum value that can be returned is 14400.", + "description": "Maximum number of result items to return.", "location": "query", "type": "string" }, @@ -6486,7 +6486,7 @@ "type": "string" }, "sortby": { - "description": "Comma-separated list of columns to sort the final result.", + "description": "Comma-separated list of metrics to sort the final result.", "location": "query", "type": "string" }, @@ -7690,7 +7690,7 @@ "type": "string" }, "limit": { - "description": "Maximum number of result items to return. The default and maximum value that can be returned is 14400.", + "description": "Maximum number of result items to return.", "location": "query", "type": "string" }, @@ -7727,7 +7727,7 @@ "type": "string" }, "sortby": { - "description": "Comma-separated list of columns to sort the final result.", + "description": "Comma-separated list of metrics to sort the final result.", "location": "query", "type": "string" }, @@ -8407,7 +8407,7 @@ "type": "string" }, "limit": { - "description": "Maximum number of result items to return. The default and maximum value that can be returned is 14400.", + "description": "Maximum number of result items to return.", "location": "query", "type": "string" }, @@ -8439,7 +8439,7 @@ "type": "string" }, "sortby": { - "description": "Comma-separated list of columns to sort the final result.", + "description": "Comma-separated list of metrics to sort the final result.", "location": "query", "type": "string" }, @@ -9284,7 +9284,7 @@ "type": "string" }, "limit": { - "description": "Maximum number of result items to return. The default and maximum value that can be returned is 14400.", + "description": "Maximum number of result items to return.", "location": "query", "type": "string" }, @@ -9316,7 +9316,7 @@ "type": "string" }, "sortby": { - "description": "Comma-separated list of columns used to sort the final result.", + "description": "Comma-separated list of metrics used to sort the final result.", "location": "query", "type": "string" }, @@ -11063,7 +11063,7 @@ } } }, - "revision": "20250312", + "revision": "20250425", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -11942,7 +11942,7 @@ "type": "boolean" }, "expiresAt": { - "description": "Output only. Time at which the API Security add-on expires in in milliseconds since epoch. If unspecified, the add-on will never expire.", + "description": "Output only. Time at which the API Security add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.", "format": "int64", "readOnly": true, "type": "string" @@ -13717,7 +13717,7 @@ "type": "string" }, "appId": { - "description": "ID of the developer app.", + "description": "ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.", "type": "string" }, "attributes": { @@ -14018,7 +14018,7 @@ "type": "string" }, "targetProjectId": { - "description": "Required. The ID of the project containing the private DNS zone.", + "description": "Required. The ID of the project that contains the producer VPC network.", "type": "string" } }, @@ -14957,7 +14957,7 @@ "type": "string" }, "diskEncryptionKeyName": { - "description": "Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`", + "description": "Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`", "type": "string" }, "displayName": { @@ -16306,6 +16306,7 @@ "type": "object" }, "GoogleCloudApigeeV1OptimizedStats": { + "description": "Encapsulates a response format for JavaScript Optimized Scenario.", "id": "GoogleCloudApigeeV1OptimizedStats", "properties": { "Response": { @@ -16320,6 +16321,7 @@ "id": "GoogleCloudApigeeV1OptimizedStatsNode", "properties": { "data": { + "description": "List of data values.", "items": { "type": "any" }, @@ -16360,7 +16362,7 @@ "properties": { "addonsConfig": { "$ref": "GoogleCloudApigeeV1AddonsConfig", - "description": "Addon configurations of the Apigee organization." + "description": "Optional. Addon configurations of the Apigee organization." }, "analyticsRegion": { "deprecated": true, @@ -16368,11 +16370,11 @@ "type": "string" }, "apiConsumerDataEncryptionKeyName": { - "description": "Cloud KMS key name used for encrypting API consumer data. If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`", + "description": "Optional. Cloud KMS key name used for encrypting API consumer data. If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`", "type": "string" }, "apiConsumerDataLocation": { - "description": "This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: \"us-west1\" when control plane is in US or \"europe-west2\" when control plane is in EU.", + "description": "Optional. This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: \"us-west1\" when control plane is in US or \"europe-west2\" when control plane is in EU.", "type": "string" }, "apigeeProjectId": { @@ -16388,11 +16390,11 @@ "type": "array" }, "authorizedNetwork": { - "description": "Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: `default`. When changing authorizedNetwork, you must reconfigure VPC peering. After VPC peering with previous network is deleted, [run the following command](https://cloud.google.com/sdk/gcloud/reference/services/vpc-peerings/delete): `gcloud services vpc-peerings delete --network=NETWORK`, where `NETWORK` is the name of the previous network. This will delete the previous Service Networking. Otherwise, you will get the following error: `The resource 'projects/...-tp' is already linked to another shared VPC host 'projects/...-tp`. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` **Note:** Not supported for Apigee hybrid.", + "description": "Optional. Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: `default`. When changing authorizedNetwork, you must reconfigure VPC peering. After VPC peering with previous network is deleted, [run the following command](https://cloud.google.com/sdk/gcloud/reference/services/vpc-peerings/delete): `gcloud services vpc-peerings delete --network=NETWORK`, where `NETWORK` is the name of the previous network. This will delete the previous Service Networking. Otherwise, you will get the following error: `The resource 'projects/...-tp' is already linked to another shared VPC host 'projects/...-tp`. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` **Note:** Not supported for Apigee hybrid.", "type": "string" }, "billingType": { - "description": "Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing).", + "description": "Optional. Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing).", "enum": [ "BILLING_TYPE_UNSPECIFIED", "SUBSCRIPTION", @@ -16414,7 +16416,7 @@ "type": "string" }, "controlPlaneEncryptionKeyName": { - "description": "Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region \"US\" or \"EU\". If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`", + "description": "Optional. Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region \"US\" or \"EU\". If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`", "type": "string" }, "createdAt": { @@ -16428,7 +16430,7 @@ "type": "string" }, "description": { - "description": "Description of the Apigee organization.", + "description": "Optional. Description of the Apigee organization.", "type": "string" }, "disableVpcPeering": { @@ -16436,7 +16438,7 @@ "type": "boolean" }, "displayName": { - "description": "Display name for the Apigee organization. Unused, but reserved for future use.", + "description": "Optional. Display name for the Apigee organization. Unused, but reserved for future use.", "type": "string" }, "environments": { @@ -16465,7 +16467,7 @@ "type": "string" }, "portalDisabled": { - "description": "Configuration for the Portals settings.", + "description": "Optional. Configuration for the Portals settings.", "type": "boolean" }, "projectId": { @@ -16475,10 +16477,10 @@ }, "properties": { "$ref": "GoogleCloudApigeeV1Properties", - "description": "Properties defined in the Apigee organization profile." + "description": "Optional. Properties defined in the Apigee organization profile." }, "runtimeDatabaseEncryptionKeyName": { - "description": "Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified or [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: \"projects/foo/locations/us/keyRings/bar/cryptoKeys/baz\". **Note:** Not supported for Apigee hybrid.", + "description": "Optional. Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified or [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: \"projects/foo/locations/us/keyRings/bar/cryptoKeys/baz\". **Note:** Not supported for Apigee hybrid.", "type": "string" }, "runtimeType": { diff --git a/discovery/appengine-v1.json b/discovery/appengine-v1.json index 7c5f8704789..ef5b99407a7 100644 --- a/discovery/appengine-v1.json +++ b/discovery/appengine-v1.json @@ -958,6 +958,12 @@ "required": true, "type": "string" }, + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1862,6 +1868,67 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "appengine.projects.locations.applications.services.versions.patch", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId", + "servicesId", + "versionsId" + ], + "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 resource to update. Example: apps/myapp/services/default/versions/1.", + "location": "path", + "required": true, + "type": "string" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", + "request": { + "$ref": "Version" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1874,7 +1941,7 @@ } } }, - "revision": "20250310", + "revision": "20250409", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/discovery/appengine-v1alpha.json b/discovery/appengine-v1alpha.json index c9aea7609b8..388bd77a901 100644 --- a/discovery/appengine-v1alpha.json +++ b/discovery/appengine-v1alpha.json @@ -598,6 +598,12 @@ "required": true, "type": "string" }, + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -754,6 +760,12 @@ "projectsId" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -946,7 +958,7 @@ } } }, - "revision": "20241118", + "revision": "20250409", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { diff --git a/discovery/appengine-v1beta.json b/discovery/appengine-v1beta.json index 7d906138afa..6e2e47bd391 100644 --- a/discovery/appengine-v1beta.json +++ b/discovery/appengine-v1beta.json @@ -958,6 +958,12 @@ "required": true, "type": "string" }, + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1726,6 +1732,12 @@ "projectsId" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1969,6 +1981,67 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "appengine.projects.locations.applications.services.versions.patch", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId", + "servicesId", + "versionsId" + ], + "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 resource to update. Example: apps/myapp/services/default/versions/1.", + "location": "path", + "required": true, + "type": "string" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", + "request": { + "$ref": "Version" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -2074,7 +2147,7 @@ } } }, - "revision": "20250310", + "revision": "20250409", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/discovery/apphub-v1.json b/discovery/apphub-v1.json index b4ac9ae2a5d..6a01297e742 100644 --- a/discovery/apphub-v1.json +++ b/discovery/apphub-v1.json @@ -171,6 +171,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1346,7 +1352,7 @@ } } }, - "revision": "20250115", + "revision": "20250414", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/discovery/apphub-v1alpha.json b/discovery/apphub-v1alpha.json index be554f4e407..30c57d2914a 100644 --- a/discovery/apphub-v1alpha.json +++ b/discovery/apphub-v1alpha.json @@ -171,6 +171,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1438,7 +1444,7 @@ } } }, - "revision": "20250115", + "revision": "20250414", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/discovery/areainsights-v1.json b/discovery/areainsights-v1.json index 0272455dd54..cec41417688 100644 --- a/discovery/areainsights-v1.json +++ b/discovery/areainsights-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://areainsights.googleapis.com/", "batchPath": "batch", "canonicalName": "Area Insights", - "description": "Places Insights API.", + "description": "Places Aggregate API.", "discoveryVersion": "v1", "documentationLink": "https://g3doc.corp.google.com/geo/platform/area_insights/README.md?cl=head", "fullyEncodeReservedExpansion": true, @@ -108,7 +108,7 @@ "v1": { "methods": { "computeInsights": { - "description": "Compute Insights RPC This method lets you retrieve insights about areas using a variaty of filter such as: area, place type, operating status, price level and ratings. Currently \"count\" and \"places\" insights are supported. With \"count\" insights you can answer questions such as \"How many restaurant are located in California that are operational, are inexpensive and have an average rating of at least 4 stars\" (see `insight` enum for more details). With \"places\" insights, you can determine which places match the requested filter. Clients can then use those place resource names to fetch more details about each individual place using the Places API.", + "description": "This method lets you retrieve insights about areas using a variety of filter such as: area, place type, operating status, price level and ratings. Currently \"count\" and \"places\" insights are supported. With \"count\" insights you can answer questions such as \"How many restaurant are located in California that are operational, are inexpensive and have an average rating of at least 4 stars\" (see `insight` enum for more details). With \"places\" insights, you can determine which places match the requested filter. Clients can then use those place resource names to fetch more details about each individual place using the Places API.", "flatPath": "v1:computeInsights", "httpMethod": "POST", "id": "areainsights.computeInsights", @@ -128,7 +128,7 @@ } } }, - "revision": "20250226", + "revision": "20250325", "rootUrl": "https://areainsights.googleapis.com/", "schemas": { "Circle": { @@ -396,7 +396,7 @@ } }, "servicePath": "", - "title": "Places Insights API", + "title": "Places Aggregate API", "version": "v1", "version_module": true } \ No newline at end of file diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index 10ae376377d..f8702147bb3 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -233,6 +233,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -452,6 +462,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2439,7 +2455,7 @@ } } }, - "revision": "20241205", + "revision": "20250423", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2578,7 +2594,7 @@ "id": "BatchDeleteVersionsRequest", "properties": { "names": { - "description": "Required. The names of the versions to delete. A maximum of 10000 versions can be deleted in a batch.", + "description": "Required. The names of the versions to delete. The maximum number of versions deleted per batch is determined by the service and is dependent on the available resources in the region.", "items": { "type": "string" }, diff --git a/discovery/artifactregistry-v1beta1.json b/discovery/artifactregistry-v1beta1.json index cd2025b7fc9..3bd256329e3 100644 --- a/discovery/artifactregistry-v1beta1.json +++ b/discovery/artifactregistry-v1beta1.json @@ -233,6 +233,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -364,6 +374,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1156,7 +1172,7 @@ } } }, - "revision": "20241010", + "revision": "20250423", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/artifactregistry-v1beta2.json b/discovery/artifactregistry-v1beta2.json index 42400d9bbac..027b0d6924d 100644 --- a/discovery/artifactregistry-v1beta2.json +++ b/discovery/artifactregistry-v1beta2.json @@ -233,6 +233,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -426,6 +436,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1424,7 +1440,7 @@ } } }, - "revision": "20241010", + "revision": "20250415", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/discovery/assuredworkloads-v1.json b/discovery/assuredworkloads-v1.json index 1cb0a663005..2e2abcec9fb 100644 --- a/discovery/assuredworkloads-v1.json +++ b/discovery/assuredworkloads-v1.json @@ -197,7 +197,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. Page size. If a value is not specified, the default value of 10 is used.", + "description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", "format": "int32", "location": "query", "type": "integer" @@ -291,6 +291,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "enableComplianceUpdates": { + "description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", + "httpMethod": "PUT", + "id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:enableComplianceUpdates", + "response": { + "$ref": "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "enableResourceMonitoring": { "description": "Enable resource violation monitoring for a workload.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", @@ -474,6 +499,74 @@ } }, "resources": { + "updates": { + "methods": { + "apply": { + "description": "This endpoint creates a new operation to apply the given update.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", + "httpMethod": "POST", + "id": "assuredworkloads.organizations.locations.workloads.updates.apply", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:apply", + "request": { + "$ref": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "This endpoint lists all updates for the given workload.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.updates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Page size. The default value is 20 and the max allowed value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token returned from previous request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/updates", + "response": { + "$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "violations": { "methods": { "acknowledge": { @@ -591,7 +684,7 @@ } } }, - "revision": "20250213", + "revision": "20250410", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -648,6 +741,65 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateOperationMetadata": { + "description": "Operation metadata to give request details of ApplyWorkloadUpdate.", + "id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateOperationMetadata", + "properties": { + "action": { + "description": "Optional. The time the operation was created.", + "enum": [ + "WORKLOAD_UPDATE_ACTION_UNSPECIFIED", + "APPLY" + ], + "enumDescriptions": [ + "Unspecified value.", + "The update is applied." + ], + "type": "string" + }, + "createTime": { + "description": "Optional. Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "updateName": { + "description": "Required. The resource name of the update", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest": { + "description": "Request to apply update to a workload.", + "id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest", + "properties": { + "action": { + "description": "The action to be performed on the update.", + "enum": [ + "WORKLOAD_UPDATE_ACTION_UNSPECIFIED", + "APPLY" + ], + "enumDescriptions": [ + "Unspecified value.", + "The update is applied." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse": { + "description": "Response for ApplyWorkloadUpdate endpoint.", + "id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse", + "properties": { + "appliedUpdate": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadUpdate", + "description": "The update that was applied." + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis": { "description": "Represents move analysis results for an asset.", "id": "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis", @@ -775,6 +927,12 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse": { + "description": "Response for EnableComplianceUpdates endpoint.", + "id": "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse": { "description": "Response for EnableResourceMonitoring endpoint.", "id": "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse", @@ -799,6 +957,24 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse": { + "description": "Response of listing the compliance updates per workload with pagination.", + "id": "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse", + "properties": { + "nextPageToken": { + "description": "The next page token. Return empty if reached the last page.", + "type": "string" + }, + "workloadUpdates": { + "description": "The list of workload updates for a given workload.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadUpdate" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse": { "description": "Response of ListWorkloads endpoint.", "id": "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse", @@ -888,6 +1064,92 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1OrgPolicy": { + "description": "This assured workload service object is used to represent the org policy attached to a resource. It servces the same purpose as the orgpolicy.v2.Policy object but with functionality that is limited to what is supported by Assured Workloads(e.g. only one rule under one OrgPolicy object, no conditions, etc).", + "id": "GoogleCloudAssuredworkloadsV1OrgPolicy", + "properties": { + "constraint": { + "description": "The constraint name of the OrgPolicy. e.g. \"constraints/gcp.resourceLocations\".", + "type": "string" + }, + "inherit": { + "description": "If `inherit` is true, policy rules of the lowest ancestor in the resource hierarchy chain are inherited. If it is false, policy rules are not inherited.", + "type": "boolean" + }, + "reset": { + "description": "Ignores policies set above this resource and restores to the `constraint_default` value. `reset` can only be true when `rules` is empty and `inherit` is false.", + "type": "boolean" + }, + "resource": { + "description": "Resource that the OrgPolicy attaches to. Format: folders/123\" projects/123\".", + "type": "string" + }, + "rule": { + "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule", + "description": "The rule of the OrgPolicy." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule": { + "description": "A rule used to express this policy.", + "id": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule", + "properties": { + "allowAll": { + "description": "ListPolicy only when all values are allowed.", + "type": "boolean" + }, + "denyAll": { + "description": "ListPolicy only when all values are denied.", + "type": "boolean" + }, + "enforce": { + "description": "BooleanPolicy only.", + "type": "boolean" + }, + "values": { + "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues", + "description": "ListPolicy only when custom values are specified." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues": { + "description": "The values allowed for a ListPolicy.", + "id": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues", + "properties": { + "allowedValues": { + "description": "List of values allowed at this resource.", + "items": { + "type": "string" + }, + "type": "array" + }, + "deniedValues": { + "description": "List of values denied at this resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1OrgPolicyUpdate": { + "description": "Represents an update for an org policy control applied on an Assured Workload resource. The inherited org policy is not considered.", + "id": "GoogleCloudAssuredworkloadsV1OrgPolicyUpdate", + "properties": { + "appliedPolicy": { + "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicy", + "description": "The org policy currently applied on the assured workload resource." + }, + "suggestedPolicy": { + "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicy", + "description": "The suggested org policy that replaces the applied policy." + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest": { "description": "Request for restricting list of available resources in Workload environment.", "id": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest", @@ -917,6 +1179,17 @@ "properties": {}, "type": "object" }, + "GoogleCloudAssuredworkloadsV1UpdateDetails": { + "description": "The details of the update.", + "id": "GoogleCloudAssuredworkloadsV1UpdateDetails", + "properties": { + "orgPolicyUpdate": { + "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicyUpdate", + "description": "Update to one org policy, e.g. gcp.resourceLocation." + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1Violation": { "description": "Workload monitoring Violation.", "id": "GoogleCloudAssuredworkloadsV1Violation", @@ -1663,6 +1936,49 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1WorkloadUpdate": { + "description": "A workload update is a change to the workload's compliance configuration.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadUpdate", + "properties": { + "createTime": { + "description": "The time the update was created.", + "format": "google-datetime", + "type": "string" + }, + "details": { + "$ref": "GoogleCloudAssuredworkloadsV1UpdateDetails", + "description": "The details of the update." + }, + "name": { + "description": "Output only. Immutable. Identifier. Resource name of the WorkloadUpdate. Format: organizations/{organization}/locations/{location}/workloads/{workload}/updates/{update}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the update.", + "enum": [ + "STATE_UNSPECIFIED", + "AVAILABLE", + "APPLIED", + "WITHDRAWN" + ], + "enumDescriptions": [ + "Unspecified.", + "The update is available to be applied.", + "The update has been applied.", + "The update has been withdrawn by the service." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "The time the update was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions": { "description": "Options to be set for the given created workload.", "id": "GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions", diff --git a/discovery/assuredworkloads-v1beta1.json b/discovery/assuredworkloads-v1beta1.json index 4b4a86d4836..fcaad624484 100644 --- a/discovery/assuredworkloads-v1beta1.json +++ b/discovery/assuredworkloads-v1beta1.json @@ -197,7 +197,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. Page size. If a value is not specified, the default value of 10 is used.", + "description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", "format": "int32", "location": "query", "type": "integer" @@ -656,7 +656,7 @@ } } }, - "revision": "20250213", + "revision": "20250410", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index c1ac85c76a2..cb320d64f18 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1680,7 +1686,7 @@ "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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.", "format": "int32", "location": "query", "type": "integer" @@ -1745,7 +1751,7 @@ } } }, - "revision": "20250305", + "revision": "20250411", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2628,14 +2634,16 @@ "CREATING", "ACTIVE", "DELETING", - "INACTIVE" + "INACTIVE", + "UPDATING" ], "enumDescriptions": [ "State not set.", "The resource is being created.", "The resource has been created and is fully usable.", "The resource is being deleted.", - "The resource has been created but is not usable." + "The resource has been created but is not usable.", + "The resource is being updated." ], "readOnly": true, "type": "string" @@ -2724,7 +2732,7 @@ "id": "BackupRule", "properties": { "backupRetentionDays": { - "description": "Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.", + "description": "Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 186 for daily backups. Minimum value is 7 and maximum value is 366 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.", "format": "int32", "type": "integer" }, diff --git a/discovery/baremetalsolution-v2.json b/discovery/baremetalsolution-v2.json index 394af57f49e..432326c3213 100644 --- a/discovery/baremetalsolution-v2.json +++ b/discovery/baremetalsolution-v2.json @@ -142,6 +142,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1722,7 +1728,7 @@ } } }, - "revision": "20240830", + "revision": "20250414", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 2980454ebcd..5eaad83d7c8 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -589,7 +595,7 @@ } } }, - "revision": "20250122", + "revision": "20250409", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index 9fa1230c616..84239b21ba6 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -376,6 +376,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1287,44 +1293,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "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", - "id": "beyondcorp.projects.locations.appGateways.shouldThrottle", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the resource", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$", - "required": true, - "type": "string" - }, - "port": { - "description": "Optional. The port that is being throttled", - "format": "int32", - "location": "query", - "type": "integer" - }, - "requestedAmount": { - "description": "Optional. The current throughput through the port (mbps)", - "format": "int64", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:shouldThrottle", - "response": { - "$ref": "ShouldThrottleResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions", @@ -2199,7 +2167,7 @@ } } }, - "revision": "20250305", + "revision": "20250409", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -4043,18 +4011,6 @@ }, "type": "object" }, - "ShouldThrottleResponse": { - "deprecated": true, - "description": "Response message for calling ShouldThrottle", - "id": "ShouldThrottleResponse", - "properties": { - "shouldThrottle": { - "description": "Whether the port should be throttled", - "type": "boolean" - } - }, - "type": "object" - }, "Tunnelv1ProtoTunnelerError": { "description": "TunnelerError is an error proto for errors returned by the connection manager.", "id": "Tunnelv1ProtoTunnelerError", diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index de79a280a62..c6747294ea9 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -113,40 +113,6 @@ "resources": { "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", - "id": "beyondcorp.organizations.locations.global.partnerTenants.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the parent organization using the form: `organizations/{organization_id}/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+parent}/partnerTenants", - "request": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { "deprecated": true, "description": "Deletes a single PartnerTenant.", @@ -249,46 +215,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "deprecated": true, - "description": "Updates a single PartnerTenant.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}", - "httpMethod": "PATCH", - "id": "beyondcorp.organizations.locations.global.partnerTenants.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Unique resource name of the PartnerTenant. The name is ignored when creating PartnerTenant.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the PartnerTenant 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. Mutable fields: display_name, partner_metadata, group_information.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "request": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:testIamPermissions", @@ -321,158 +247,6 @@ "resources": { "browserDlpRules": { "methods": { - "create": { - "description": "Creates a new BrowserDlpRule in a given organization and PartnerTenant.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules", - "httpMethod": "POST", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the BrowserDlpRule parent using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+parent}/browserDlpRules", - "request": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an existing BrowserDlpRule.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}", - "httpMethod": "DELETE", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the BrowserDlpRule using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}/browserDlpRules/{browser_dlp_rule_id}`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single BrowserDlpRule.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the BrowserDlpRule using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}/browserDlpRules/{browser_dlp_rule_id}`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule" - }, - "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", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent partnerTenant to which the BrowserDlpRules belong. Format: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/browserDlpRules", - "response": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaListBrowserDlpRulesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Update an existing BrowserDlpRule in a given organization and PartnerTenant.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}", - "httpMethod": "PATCH", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Unique resource name. The name is ignored when creating BrowserDlpRule.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "updateMask": { - "description": "Required. Supported fields include: rule_setting.value.*, group.id/group.email.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "request": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions", @@ -505,184 +279,6 @@ }, "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", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the parent PartnerTenant using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+parent}/proxyConfigs", - "request": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "deprecated": true, - "description": "Deletes a single ProxyConfig.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}", - "httpMethod": "DELETE", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the resource.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "deprecated": true, - "description": "Gets details of a single ProxyConfig.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the ProxyConfig using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}/proxyConfigs/{proxy_config_id}`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig" - }, - "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", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. A filter specifying constraints of a list operation. All fields in the ProxyConfig message are supported. For example, the following query will return the ProxyConfigs with displayName \"test-config\" organizations/${ORG_ID}/locations/global/partnerTenants/${PARTNER_TENANT_ID}/proxyConfigs?filter=displayName=\"test-config\" Nested fields are also supported. The follow query will return ProxyConfigs with pacUri \"example.com/pac.pac\" organizations/${ORG_ID}/locations/global/partnerTenants/${PARTNER_TENANT_ID}/proxyConfigs?filter=routingInfo.pacUri=\"example.com/pac.pac\" For more information, please refer to https://google.aip.dev/160.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous ListProxyConfigsRequest, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent organization to which the ProxyConfigs belong. Format: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/proxyConfigs", - "response": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaListProxyConfigsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "deprecated": true, - "description": "Updates a single proxy config.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}", - "httpMethod": "PATCH", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. ProxyConfig resource name.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "updateMask": { - "description": "Required. Mutable fields include: display_name, proxy_uri, routing_info, transport_info, encryption_info.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "request": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions", @@ -1284,6 +880,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2195,44 +1797,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "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", - "id": "beyondcorp.projects.locations.appGateways.shouldThrottle", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the resource", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$", - "required": true, - "type": "string" - }, - "port": { - "description": "Optional. The port that is being throttled", - "format": "int32", - "location": "query", - "type": "integer" - }, - "requestedAmount": { - "description": "Optional. The current throughput through the port (mbps)", - "format": "int64", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}:shouldThrottle", - "response": { - "$ref": "ShouldThrottleResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions", @@ -4128,7 +3692,7 @@ } } }, - "revision": "20250305", + "revision": "20250409", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5523,41 +5087,6 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule": { - "description": "Browser DLP Rule for a PartnerTenant", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule", - "properties": { - "group": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaGroup", - "description": "Required. The group to which this Rule should be applied to." - }, - "name": { - "description": "Output only. Unique resource name. The name is ignored when creating BrowserDlpRule.", - "readOnly": true, - "type": "string" - }, - "ruleSetting": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaRuleSetting", - "description": "Required. The policy settings to apply." - } - }, - "type": "object" - }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaEncryptionInfo": { - "description": "Message contains the JWT encryption information for the proxy server.", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaEncryptionInfo", - "properties": { - "encryptionSaEmail": { - "description": "Optional. Service Account for encryption key.", - "type": "string" - }, - "jwk": { - "description": "Optional. JWK in string.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudBeyondcorpPartnerservicesV1alphaGroup": { "description": "Message to capture group information", "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaGroup", @@ -5573,20 +5102,6 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaListBrowserDlpRulesResponse": { - "description": "Message for response to listing BrowserDlpRules.", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaListBrowserDlpRulesResponse", - "properties": { - "browserDlpRules": { - "description": "The list of BrowserDlpRule objects.", - "items": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudBeyondcorpPartnerservicesV1alphaListPartnerTenantsResponse": { "description": "Message for response to listing PartnerTenants.", "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaListPartnerTenantsResponse", @@ -5605,24 +5120,6 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaListProxyConfigsResponse": { - "description": "Message for response to listing ProxyConfigs.", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaListProxyConfigsResponse", - "properties": { - "nextPageToken": { - "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - }, - "proxyConfigs": { - "description": "The list of ProxyConfig objects.", - "items": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerMetadata": { "description": "Metadata associated with PartnerTenant and is provided by the Partner.", "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerMetadata", @@ -5718,113 +5215,6 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig": { - "description": "Proxy Configuration of a PartnerTenant.", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig", - "properties": { - "createTime": { - "description": "Output only. Timestamp when the resource was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "Optional. An arbitrary caller-provided name for the ProxyConfig. Cannot exceed 64 characters.", - "type": "string" - }, - "encryptionInfo": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaEncryptionInfo", - "description": "Optional. Information to encrypt JWT for the proxy server." - }, - "name": { - "description": "Output only. ProxyConfig resource name.", - "readOnly": true, - "type": "string" - }, - "proxyProtocolConfig": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig", - "description": "Optional. Protocol config data for the Proxy." - }, - "proxyUri": { - "description": "Required. The URI of the proxy server.", - "type": "string" - }, - "routingInfo": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo", - "description": "Required. Routing info to direct traffic to the proxy server." - }, - "transportInfo": { - "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaTransportInfo", - "description": "Optional. Transport layer information to verify for the proxy server." - }, - "updateTime": { - "description": "Output only. Timestamp when the resource was last modified.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig": { - "description": "The protocol data that specifies how to communicate with Partner's Proxy.", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig", - "properties": { - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Untyped property bag to be sent back to the proxy using client specific mechanism.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo": { - "description": "Message contains the routing information to direct traffic to the proxy server.", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo", - "properties": { - "pacUri": { - "description": "Required. Proxy Auto-Configuration (PAC) URI.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaRuleSetting": { - "description": "Message to capture settings for a BrowserDlpRule", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaRuleSetting", - "properties": { - "type": { - "description": "Required. Immutable. The type of the Setting. .", - "type": "string" - }, - "value": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Required. The value of the Setting.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudBeyondcorpPartnerservicesV1alphaTransportInfo": { - "description": "Message contains the transport layer information to verify the proxy server.", - "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaTransportInfo", - "properties": { - "serverCaCertPem": { - "description": "Required. PEM encoded CA certificate associated with the proxy server certificate.", - "type": "string" - }, - "sslDecryptCaCertPem": { - "description": "Optional. PEM encoded CA certificate associated with the certificate used by proxy server for SSL decryption.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudBeyondcorpPartnerservicesV1mainPartnerServiceOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpPartnerservicesV1mainPartnerServiceOperationMetadata", @@ -7125,18 +6515,6 @@ }, "type": "object" }, - "ShouldThrottleResponse": { - "deprecated": true, - "description": "Response message for calling ShouldThrottle", - "id": "ShouldThrottleResponse", - "properties": { - "shouldThrottle": { - "description": "Whether the port should be throttled", - "type": "boolean" - } - }, - "type": "object" - }, "Tunnelv1ProtoTunnelerError": { "description": "TunnelerError is an error proto for errors returned by the connection manager.", "id": "Tunnelv1ProtoTunnelerError", diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index d8289925008..92a01a45056 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -2256,7 +2256,7 @@ } } }, - "revision": "20250313", + "revision": "20250404", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2853,7 +2853,7 @@ "type": "object" }, "BigLakeConfiguration": { - "description": "Configuration for BigLake managed tables.", + "description": "Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.)", "id": "BigLakeConfiguration", "properties": { "connectionId": { @@ -8897,7 +8897,7 @@ "properties": { "biglakeConfiguration": { "$ref": "BigLakeConfiguration", - "description": "Optional. Specifies the configuration of a BigLake managed table." + "description": "Optional. Specifies the configuration of a BigQuery table for Apache Iceberg." }, "cloneDefinition": { "$ref": "CloneDefinition", diff --git a/discovery/bigquerydatapolicy-v1.json b/discovery/bigquerydatapolicy-v1.json index fd53719c67e..f7413516d1e 100644 --- a/discovery/bigquerydatapolicy-v1.json +++ b/discovery/bigquerydatapolicy-v1.json @@ -405,7 +405,7 @@ } } }, - "revision": "20240806", + "revision": "20250317", "rootUrl": "https://bigquerydatapolicy.googleapis.com/", "schemas": { "AuditConfig": { @@ -526,7 +526,7 @@ "type": "string" }, "dataPolicyType": { - "description": "Type of data policy.", + "description": "Required. Data policy type. Type of data policy.", "enum": [ "DATA_POLICY_TYPE_UNSPECIFIED", "COLUMN_LEVEL_SECURITY_POLICY", diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index b0e4c9feb03..35d1d998d00 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -238,7 +238,7 @@ ], "parameters": { "name": { - "description": "Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.", + "description": "Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "location": "path", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "required": true, @@ -268,7 +268,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "location": "path", "pattern": "^projects/[^/]+/dataSources/[^/]+$", "required": true, @@ -392,6 +392,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -469,7 +475,7 @@ ], "parameters": { "name": { - "description": "Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.", + "description": "Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "required": true, @@ -499,7 +505,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/dataSources/{data_source_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", "required": true, @@ -612,7 +618,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The name of the resource to delete. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -638,7 +644,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -682,7 +688,7 @@ "type": "string" }, "parent": { - "description": "Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`", + "description": "Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id}/locations/{location_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -760,7 +766,7 @@ ], "parameters": { "parent": { - "description": "Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -780,7 +786,7 @@ ] }, "startManualRuns": { - "description": "Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.", + "description": "Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns", @@ -789,7 +795,7 @@ ], "parameters": { "parent": { - "description": "Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -822,7 +828,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -848,7 +854,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -886,7 +892,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -981,7 +987,7 @@ "type": "string" }, "parent": { - "description": "Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -1062,7 +1068,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The name of the resource to delete. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1088,7 +1094,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1132,7 +1138,7 @@ "type": "string" }, "parent": { - "description": "Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`", + "description": "Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id}/locations/{location_id}`", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1210,7 +1216,7 @@ ], "parameters": { "parent": { - "description": "Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1230,7 +1236,7 @@ ] }, "startManualRuns": { - "description": "Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.", + "description": "Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.", "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns", "httpMethod": "POST", "id": "bigquerydatatransfer.projects.transferConfigs.startManualRuns", @@ -1239,7 +1245,7 @@ ], "parameters": { "parent": { - "description": "Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1272,7 +1278,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -1298,7 +1304,7 @@ ], "parameters": { "name": { - "description": "Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -1336,7 +1342,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.", + "description": "Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1431,7 +1437,7 @@ "type": "string" }, "parent": { - "description": "Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", + "description": "Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", "required": true, @@ -1457,7 +1463,7 @@ } } }, - "revision": "20240922", + "revision": "20250423", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index d6f3f762cbd..edcb806649f 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -736,7 +736,7 @@ ], "parameters": { "name": { - "description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.", + "description": "Identifier. The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", "required": true, @@ -935,7 +935,7 @@ } } }, - "revision": "20250316", + "revision": "20250421", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1004,7 +1004,7 @@ "type": "string" }, "maxSlots": { - "description": "Number of slots to be scaled when needed.", + "description": "Optional. Number of slots to be scaled when needed.", "format": "int64", "type": "string" } @@ -1325,10 +1325,10 @@ "properties": { "autoscale": { "$ref": "Autoscale", - "description": "The configuration parameters for the auto scaling feature." + "description": "Optional. The configuration parameters for the auto scaling feature." }, "concurrency": { - "description": "Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI.", + "description": "Optional. Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI.", "format": "int64", "type": "string" }, @@ -1339,7 +1339,7 @@ "type": "string" }, "edition": { - "description": "Edition of the reservation.", + "description": "Optional. Edition of the reservation.", "enum": [ "EDITION_UNSPECIFIED", "STANDARD", @@ -1355,7 +1355,7 @@ "type": "string" }, "ignoreIdleSlots": { - "description": "If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.", + "description": "Optional. If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.", "type": "boolean" }, "labels": { @@ -1371,11 +1371,12 @@ "type": "string" }, "multiRegionAuxiliary": { + "deprecated": true, "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" }, "name": { - "description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.", + "description": "Identifier. The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.", "type": "string" }, "originalPrimaryLocation": { @@ -1394,7 +1395,7 @@ "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`.", + "description": "Optional. 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", @@ -1414,7 +1415,7 @@ "type": "string" }, "slotCapacity": { - "description": "Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.", + "description": "Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.", "format": "int64", "type": "string" }, diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index b1aabdbdfda..502c55badd0 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -695,7 +695,7 @@ "type": "boolean" }, "name": { - "description": "The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.", + "description": "The unique name of the app profile, up to 50 characters long. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+/appProfiles/[^/]+$", "required": true, @@ -1313,6 +1313,109 @@ }, "logicalViews": { "methods": { + "create": { + "description": "Creates a logical view within an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.logicalViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "logicalViewId": { + "description": "Required. The ID to use for the logical view, which will become the final component of the logical view's resource name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent instance where this logical view will be created. Format: `projects/{project}/instances/{instance}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logicalViews", + "request": { + "$ref": "LogicalView" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a logical view from an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}", + "httpMethod": "DELETE", + "id": "bigtableadmin.projects.instances.logicalViews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The current etag of the logical view. If an etag is provided and does not match the current etag of the logical view, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The unique name of the logical view to be deleted. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/logicalViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "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" + ] + }, + "get": { + "description": "Gets information about a logical view.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}", + "httpMethod": "GET", + "id": "bigtableadmin.projects.instances.logicalViews.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique name of the requested logical view. Values are of the form `projects/{project}/instances/{instance}/logicalViews/{logical_view}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/logicalViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogicalView" + }, + "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" + ] + }, "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", @@ -1346,6 +1449,86 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Lists information about logical views in an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews", + "httpMethod": "GET", + "id": "bigtableadmin.projects.instances.logicalViews.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of logical views to return. The service may return fewer than this value", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListLogicalViews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLogicalViews` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The unique name of the instance for which the list of logical views is requested. Values are of the form `projects/{project}/instances/{instance}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logicalViews", + "response": { + "$ref": "ListLogicalViewsResponse" + }, + "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" + ] + }, + "patch": { + "description": "Updates a logical view within an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}", + "httpMethod": "PATCH", + "id": "bigtableadmin.projects.instances.logicalViews.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The unique name of the logical view. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/logicalViews/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogicalView" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on an instance resource. Replaces any existing policy.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}:setIamPolicy", @@ -1416,6 +1599,109 @@ }, "materializedViews": { "methods": { + "create": { + "description": "Creates a materialized view within an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.materializedViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "materializedViewId": { + "description": "Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent instance where this materialized view will be created. Format: `projects/{project}/instances/{instance}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/materializedViews", + "request": { + "$ref": "MaterializedView" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a materialized view from an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}", + "httpMethod": "DELETE", + "id": "bigtableadmin.projects.instances.materializedViews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The current etag of the materialized view. If an etag is provided and does not match the current etag of the materialized view, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The unique name of the materialized view to be deleted. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/materializedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "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" + ] + }, + "get": { + "description": "Gets information about a materialized view.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}", + "httpMethod": "GET", + "id": "bigtableadmin.projects.instances.materializedViews.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique name of the requested materialized view. Values are of the form `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/materializedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "MaterializedView" + }, + "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" + ] + }, "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", @@ -1449,6 +1735,86 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Lists information about materialized views in an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews", + "httpMethod": "GET", + "id": "bigtableadmin.projects.instances.materializedViews.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of materialized views to return. The service may return fewer than this value", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListMaterializedViews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMaterializedViews` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The unique name of the instance for which the list of materialized views is requested. Values are of the form `projects/{project}/instances/{instance}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/materializedViews", + "response": { + "$ref": "ListMaterializedViewsResponse" + }, + "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" + ] + }, + "patch": { + "description": "Updates a materialized view within an instance.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}", + "httpMethod": "PATCH", + "id": "bigtableadmin.projects.instances.materializedViews.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/materializedViews/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "MaterializedView" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on an instance resource. Replaces any existing policy.", "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}:setIamPolicy", @@ -1866,6 +2232,11 @@ "name" ], "parameters": { + "ignoreWarnings": { + "description": "Optional. If true, ignore safety checks when updating the table.", + "location": "query", + "type": "boolean" + }, "name": { "description": "The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL`", "location": "path", @@ -2357,6 +2728,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2400,7 +2777,7 @@ } } }, - "revision": "20250308", + "revision": "20250430", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2424,7 +2801,7 @@ "description": "Use a multi-cluster routing policy." }, "name": { - "description": "The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.", + "description": "The unique name of the app profile, up to 50 characters long. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.", "type": "string" }, "priority": { @@ -4054,6 +4431,42 @@ }, "type": "object" }, + "ListLogicalViewsResponse": { + "description": "Response message for BigtableInstanceAdmin.ListLogicalViews.", + "id": "ListLogicalViewsResponse", + "properties": { + "logicalViews": { + "description": "The list of requested logical views.", + "items": { + "$ref": "LogicalView" + }, + "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" + }, + "ListMaterializedViewsResponse": { + "description": "Response message for BigtableInstanceAdmin.ListMaterializedViews.", + "id": "ListMaterializedViewsResponse", + "properties": { + "materializedViews": { + "description": "The list of requested materialized views.", + "items": { + "$ref": "MaterializedView" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -4128,6 +4541,10 @@ "description": "A SQL logical view object that can be referenced in SQL queries.", "id": "LogicalView", "properties": { + "deletionProtection": { + "description": "Optional. Set to true to make the LogicalView protected against deletion.", + "type": "boolean" + }, "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" @@ -4615,6 +5032,10 @@ "description": "Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.", "readOnly": true }, + "rowKeySchema": { + "$ref": "GoogleBigtableAdminV2TypeStruct", + "description": "The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = \"some_id#2024-04-30#\\x00\\x13\\x00\\xf3\" with the following schema: { fields { field_name: \"id\" type { string { encoding: utf8_bytes {} } } } fields { field_name: \"date\" type { string { encoding: utf8_bytes {} } } } fields { field_name: \"product_code\" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: \"#\" } } } The decoded key parts would be: id = \"some_id\", date = \"2024-04-30\", product_code = 1245427 The query \"SELECT _key, product_code FROM table\" will return two columns: /------------------------------------------------------\\ | _key | product_code | | --------------------------------------|--------------| | \"some_id#2024-04-30#\\x00\\x13\\x00\\xf3\" | 1245427 | \\------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords \"_key\" and \"_timestamp\". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported." + }, "stats": { "$ref": "TableStats", "description": "Output only. Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.", diff --git a/discovery/blockchainnodeengine-v1.json b/discovery/blockchainnodeengine-v1.json index ff9c0e74805..5c5d3cbd55d 100644 --- a/discovery/blockchainnodeengine-v1.json +++ b/discovery/blockchainnodeengine-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -487,7 +493,7 @@ } } }, - "revision": "20241204", + "revision": "20250416", "rootUrl": "https://blockchainnodeengine.googleapis.com/", "schemas": { "BlockchainNode": { @@ -534,7 +540,8 @@ "type": "string" }, "privateServiceConnectEnabled": { - "description": "Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect.", + "deprecated": true, + "description": "Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: These nodes are deprecated, please use public endpoints instead.", "type": "boolean" }, "state": { @@ -974,6 +981,7 @@ "type": "string" }, "managedValidatorClient": { + "deprecated": true, "description": "Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.", "type": "boolean" }, diff --git a/discovery/calendar-v3.json b/discovery/calendar-v3.json index 65fcc38a17a..479df5d28c9 100644 --- a/discovery/calendar-v3.json +++ b/discovery/calendar-v3.json @@ -61,7 +61,7 @@ "batchPath": "batch/calendar/v3", "description": "Manipulates events and other calendar data.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp", + "documentationLink": "https://developers.google.com/workspace/calendar/firstapp", "icons": { "x16": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-16dp/logo_calendar_2020q4_color_1x_web_16dp.png", "x32": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-32dp/logo_calendar_2020q4_color_1x_web_32dp.png" @@ -1890,7 +1890,7 @@ } } }, - "revision": "20250115", + "revision": "20250404", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 2a35b8ea271..a4bbe2d5e43 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -32,6 +32,12 @@ "https://www.googleapis.com/auth/chat.bot": { "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, + "https://www.googleapis.com/auth/chat.customemojis": { + "description": "View, create, and delete custom emoji in Google Chat" + }, + "https://www.googleapis.com/auth/chat.customemojis.readonly": { + "description": "View custom emoji in Google Chat" + }, "https://www.googleapis.com/auth/chat.delete": { "description": "Delete conversations and spaces and remove access to associated files in Google Chat" }, @@ -183,6 +189,112 @@ }, "protocol": "rest", "resources": { + "customEmojis": { + "methods": { + "create": { + "description": "Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "flatPath": "v1/customEmojis", + "httpMethod": "POST", + "id": "chat.customEmojis.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1/customEmojis", + "request": { + "$ref": "CustomEmoji" + }, + "response": { + "$ref": "CustomEmoji" + }, + "scopes": [ + "https://www.googleapis.com/auth/chat.customemojis" + ] + }, + "delete": { + "description": "Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "flatPath": "v1/customEmojis/{customEmojisId}", + "httpMethod": "DELETE", + "id": "chat.customEmojis.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.", + "location": "path", + "pattern": "^customEmojis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/chat.customemojis" + ] + }, + "get": { + "description": "Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "flatPath": "v1/customEmojis/{customEmojisId}", + "httpMethod": "GET", + "id": "chat.customEmojis.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.", + "location": "path", + "pattern": "^customEmojis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CustomEmoji" + }, + "scopes": [ + "https://www.googleapis.com/auth/chat.customemojis", + "https://www.googleapis.com/auth/chat.customemojis.readonly" + ] + }, + "list": { + "description": "Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "flatPath": "v1/customEmojis", + "httpMethod": "GET", + "id": "chat.customEmojis.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: ``` creator(\"users/me\") ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.", + "location": "query", + "type": "string" + } + }, + "path": "v1/customEmojis", + "response": { + "$ref": "ListCustomEmojisResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chat.customemojis", + "https://www.googleapis.com/auth/chat.customemojis.readonly" + ] + } + } + }, "media": { "methods": { "download": { @@ -591,7 +703,7 @@ ] }, "delete": { - "description": "Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request.", + "description": "Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the application must be the space creator.", "flatPath": "v1/spaces/{spacesId}/members/{membersId}", "httpMethod": "DELETE", "id": "chat.spaces.members.delete", @@ -600,7 +712,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.", + "description": "Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.", "location": "path", "pattern": "^spaces/[^/]+/members/[^/]+$", "required": true, @@ -1122,7 +1234,7 @@ ], "parameters": { "filter": { - "description": "Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"🙂\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"🙂\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" AND user.name = \"users/{user}\" (emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"🙂\" AND emoji.unicode = \"👍\" emoji.unicode = \"🙂\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", + "description": "Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"🙂\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"🙂\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" AND user.name = \"users/{user}\" (emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"🙂\" AND emoji.unicode = \"👍\" emoji.unicode = \"🙂\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.", "location": "query", "type": "string" }, @@ -1184,6 +1296,8 @@ "$ref": "SpaceEvent" }, "scopes": [ + "https://www.googleapis.com/auth/chat.app.memberships", + "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages", @@ -1232,6 +1346,8 @@ "$ref": "ListSpaceEventsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/chat.app.memberships", + "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly", "https://www.googleapis.com/auth/chat.messages", @@ -1410,7 +1526,7 @@ } } }, - "revision": "20250313", + "revision": "20250427", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1997,9 +2113,26 @@ "type": "object" }, "CustomEmoji": { - "description": "Represents a custom emoji.", + "description": "Represents a [custom emoji](https://support.google.com/chat/answer/12800149).", "id": "CustomEmoji", "properties": { + "emojiName": { + "description": "Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`", + "type": "string" + }, + "payload": { + "$ref": "CustomEmojiPayload", + "description": "Optional. Input only. Payload data. Required when the custom emoji is created." + }, + "temporaryImageUri": { + "description": "Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.", + "readOnly": true, + "type": "string" + }, "uid": { "description": "Output only. Unique key for the custom emoji resource.", "readOnly": true, @@ -2019,6 +2152,22 @@ }, "type": "object" }, + "CustomEmojiPayload": { + "description": "Payload data for the custom emoji.", + "id": "CustomEmojiPayload", + "properties": { + "fileContent": { + "description": "Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.", + "format": "byte", + "type": "string" + }, + "filename": { + "description": "Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`.", + "type": "string" + } + }, + "type": "object" + }, "DateInput": { "description": "Date input values.", "id": "DateInput", @@ -2379,8 +2528,8 @@ ], "enumDescriptions": [ "Don't use. Unspecified.", - "Default value. No border.", - "Outline." + "No border.", + "Default value. Outline." ], "type": "string" } @@ -3319,12 +3468,14 @@ "description": "For multiselect menus, a text description or label that's displayed below the item's `text` field.", "type": "string" }, + "materialIcon": { + "$ref": "GoogleAppsCardV1MaterialIcon" + }, "selected": { "description": "Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.", "type": "boolean" }, "startIconUri": { - "description": "For multiselect menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`.", "type": "string" }, "text": { @@ -3872,6 +4023,24 @@ }, "type": "object" }, + "ListCustomEmojisResponse": { + "description": "A response to list custom emojis.", + "id": "ListCustomEmojisResponse", + "properties": { + "customEmojis": { + "description": "Unordered list. List of custom emojis.", + "items": { + "$ref": "CustomEmoji" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "ListMembershipsResponse": { "description": "Response to list memberships of the space.", "id": "ListMembershipsResponse", diff --git a/discovery/chromemanagement-v1.json b/discovery/chromemanagement-v1.json index 1da526e98af..92191b06d4e 100644 --- a/discovery/chromemanagement-v1.json +++ b/discovery/chromemanagement-v1.json @@ -901,7 +901,7 @@ "type": "string" }, "appType": { - "description": "Type of the app.", + "description": "Type of the app. Optional. If not provided, an app type will be inferred from the format of the app ID.", "enum": [ "APP_TYPE_UNSPECIFIED", "EXTENSION", @@ -1280,7 +1280,7 @@ } } }, - "revision": "20250313", + "revision": "20250417", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/discovery/chromepolicy-v1.json b/discovery/chromepolicy-v1.json index 53c35b68e79..610d40f5190 100644 --- a/discovery/chromepolicy-v1.json +++ b/discovery/chromepolicy-v1.json @@ -557,7 +557,7 @@ } } }, - "revision": "20241118", + "revision": "20250409", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { @@ -893,7 +893,7 @@ "type": "object" }, "GoogleChromePolicyVersionsV1NetworkSetting": { - "description": "A network setting contains network configurations.", + "description": "A network setting contains network configurations. It adheres to the PolicyAPI formats defined under the namespace chrome.networks.{wifi/ethernet/cellular/vpn}.Details", "id": "GoogleChromePolicyVersionsV1NetworkSetting", "properties": { "policySchema": { @@ -1629,6 +1629,20 @@ "$ref": "Proto2OneofDescriptorProto" }, "type": "array" + }, + "visibility": { + "description": "Support for `export` and `local` keywords on enums.", + "enum": [ + "VISIBILITY_UNSET", + "VISIBILITY_LOCAL", + "VISIBILITY_EXPORT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -1645,6 +1659,20 @@ "$ref": "Proto2EnumValueDescriptorProto" }, "type": "array" + }, + "visibility": { + "description": "Support for `export` and `local` keywords on enums.", + "enum": [ + "VISIBILITY_UNSET", + "VISIBILITY_LOCAL", + "VISIBILITY_EXPORT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -1781,6 +1809,13 @@ "description": "file name, relative to root of source tree", "type": "string" }, + "optionDependency": { + "description": "Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above.", + "items": { + "type": "string" + }, + "type": "array" + }, "package": { "description": "e.g. \"foo\", \"foo.bar\", etc.", "type": "string" diff --git a/discovery/chromeuxreport-v1.json b/discovery/chromeuxreport-v1.json index 93fcf43fbe1..8cee04deda4 100644 --- a/discovery/chromeuxreport-v1.json +++ b/discovery/chromeuxreport-v1.json @@ -131,7 +131,7 @@ } } }, - "revision": "20240916", + "revision": "20250409", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { @@ -362,6 +362,11 @@ "description": "Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience history record.", "id": "QueryHistoryRequest", "properties": { + "collectionPeriodCount": { + "description": "The number of collection periods to return. If not specified, the default is 25. If present, must be in the range [1, 40].", + "format": "int32", + "type": "integer" + }, "formFactor": { "description": "The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned.", "enum": [ diff --git a/discovery/civicinfo-v2.json b/discovery/civicinfo-v2.json index 651fcd9b373..946c9a81f94 100644 --- a/discovery/civicinfo-v2.json +++ b/discovery/civicinfo-v2.json @@ -111,7 +111,7 @@ }, "path": "civicinfo/v2/divisionsByAddress", "response": { - "$ref": "DivisionByAddressResponse" + "$ref": "CivicinfoApiprotosV2DivisionByAddressResponse" } }, "search": { @@ -129,7 +129,7 @@ }, "path": "civicinfo/v2/divisions", "response": { - "$ref": "DivisionSearchResponse" + "$ref": "CivicinfoApiprotosV2DivisionSearchResponse" } } } @@ -152,7 +152,7 @@ }, "path": "civicinfo/v2/elections", "response": { - "$ref": "ElectionsQueryResponse" + "$ref": "CivicinfoApiprotosV2ElectionsQueryResponse" } }, "voterInfoQuery": { @@ -195,7 +195,7 @@ }, "path": "civicinfo/v2/voterinfo", "response": { - "$ref": "VoterInfoResponse" + "$ref": "CivicinfoApiprotosV2VoterInfoResponse" } } } @@ -285,7 +285,7 @@ }, "path": "civicinfo/v2/representatives", "response": { - "$ref": "RepresentativeInfoResponse" + "$ref": "CivicinfoApiprotosV2RepresentativeInfoResponse" } }, "representativeInfoByDivision": { @@ -373,25 +373,240 @@ }, "path": "civicinfo/v2/representatives/{ocdId}", "response": { - "$ref": "RepresentativeInfoData" + "$ref": "CivicinfoApiprotosV2RepresentativeInfoData" } } } } }, - "revision": "20240910", + "revision": "20250320", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { - "AdministrationRegion": { + "CivicinfoApiprotosV2DivisionByAddressResponse": { + "id": "CivicinfoApiprotosV2DivisionByAddressResponse", + "properties": { + "divisions": { + "additionalProperties": { + "$ref": "CivicinfoSchemaV2GeographicDivision" + }, + "type": "object" + }, + "normalizedInput": { + "$ref": "CivicinfoSchemaV2SimpleAddressType", + "description": "The normalized version of the requested address." + } + }, + "type": "object" + }, + "CivicinfoApiprotosV2DivisionSearchResponse": { + "description": "The result of a division search query.", + "id": "CivicinfoApiprotosV2DivisionSearchResponse", + "properties": { + "kind": { + "default": "civicinfo#divisionSearchResponse", + "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".", + "type": "string" + }, + "results": { + "items": { + "$ref": "CivicinfoApiprotosV2DivisionSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "CivicinfoApiprotosV2DivisionSearchResult": { + "description": "Represents a political geographic division that matches the requested query.", + "id": "CivicinfoApiprotosV2DivisionSearchResult", + "properties": { + "aliases": { + "description": "Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name of the division.", + "type": "string" + }, + "ocdId": { + "description": "The unique Open Civic Data identifier for this division", + "type": "string" + } + }, + "type": "object" + }, + "CivicinfoApiprotosV2ElectionsQueryResponse": { + "description": "The list of elections available for this version of the API.", + "id": "CivicinfoApiprotosV2ElectionsQueryResponse", + "properties": { + "elections": { + "description": "A list of available elections", + "items": { + "$ref": "CivicinfoSchemaV2Election" + }, + "type": "array" + }, + "kind": { + "default": "civicinfo#electionsQueryResponse", + "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".", + "type": "string" + } + }, + "type": "object" + }, + "CivicinfoApiprotosV2RepresentativeInfoData": { + "id": "CivicinfoApiprotosV2RepresentativeInfoData", + "properties": { + "divisions": { + "additionalProperties": { + "$ref": "CivicinfoSchemaV2GeographicDivision" + }, + "description": "A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.", + "type": "object" + }, + "offices": { + "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.", + "items": { + "$ref": "CivicinfoSchemaV2Office" + }, + "type": "array" + }, + "officials": { + "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.", + "items": { + "$ref": "CivicinfoSchemaV2Official" + }, + "type": "array" + } + }, + "type": "object" + }, + "CivicinfoApiprotosV2RepresentativeInfoResponse": { + "description": "The result of a representative info lookup query.", + "id": "CivicinfoApiprotosV2RepresentativeInfoResponse", + "properties": { + "divisions": { + "additionalProperties": { + "$ref": "CivicinfoSchemaV2GeographicDivision" + }, + "description": "A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.", + "type": "object" + }, + "kind": { + "default": "civicinfo#representativeInfoResponse", + "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#representativeInfoResponse\".", + "type": "string" + }, + "normalizedInput": { + "$ref": "CivicinfoSchemaV2SimpleAddressType", + "description": "The normalized version of the requested address" + }, + "offices": { + "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.", + "items": { + "$ref": "CivicinfoSchemaV2Office" + }, + "type": "array" + }, + "officials": { + "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.", + "items": { + "$ref": "CivicinfoSchemaV2Official" + }, + "type": "array" + } + }, + "type": "object" + }, + "CivicinfoApiprotosV2VoterInfoResponse": { + "description": "The result of a voter info lookup query.", + "id": "CivicinfoApiprotosV2VoterInfoResponse", + "properties": { + "contests": { + "description": "Contests that will appear on the voter's ballot.", + "items": { + "$ref": "CivicinfoSchemaV2Contest" + }, + "type": "array" + }, + "dropOffLocations": { + "description": "Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.", + "items": { + "$ref": "CivicinfoSchemaV2PollingLocation" + }, + "type": "array" + }, + "earlyVoteSites": { + "description": "Locations where the voter is eligible to vote early, prior to election day.", + "items": { + "$ref": "CivicinfoSchemaV2PollingLocation" + }, + "type": "array" + }, + "election": { + "$ref": "CivicinfoSchemaV2Election", + "description": "The election that was queried." + }, + "kind": { + "default": "civicinfo#voterInfoResponse", + "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#voterInfoResponse\".", + "type": "string" + }, + "mailOnly": { + "description": "Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).", + "type": "boolean" + }, + "normalizedInput": { + "$ref": "CivicinfoSchemaV2SimpleAddressType", + "description": "The normalized version of the requested address" + }, + "otherElections": { + "description": "When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user.", + "items": { + "$ref": "CivicinfoSchemaV2Election" + }, + "type": "array" + }, + "pollingLocations": { + "description": "Locations where the voter is eligible to vote on election day.", + "items": { + "$ref": "CivicinfoSchemaV2PollingLocation" + }, + "type": "array" + }, + "precinctId": { + "type": "string" + }, + "precincts": { + "description": "The precincts that match this voter's address. Will only be returned for project IDs which have been allowlisted as \"partner projects\".", + "items": { + "$ref": "CivicinfoSchemaV2Precinct" + }, + "type": "array" + }, + "state": { + "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.", + "items": { + "$ref": "CivicinfoSchemaV2AdministrationRegion" + }, + "type": "array" + } + }, + "type": "object" + }, + "CivicinfoSchemaV2AdministrationRegion": { "description": "Describes information about a regional election administrative area.", - "id": "AdministrationRegion", + "id": "CivicinfoSchemaV2AdministrationRegion", "properties": { "electionAdministrationBody": { - "$ref": "AdministrativeBody", + "$ref": "CivicinfoSchemaV2AdministrativeBody", "description": "The election administration body for this area." }, "local_jurisdiction": { - "$ref": "AdministrationRegion", + "$ref": "CivicinfoSchemaV2AdministrationRegion", "description": "The city or county that provides election information for this voter. This object can have the same elements as state." }, "name": { @@ -401,16 +616,16 @@ "sources": { "description": "A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.", "items": { - "$ref": "Source" + "$ref": "CivicinfoSchemaV2Source" }, "type": "array" } }, "type": "object" }, - "AdministrativeBody": { + "CivicinfoSchemaV2AdministrativeBody": { "description": "Information about an election administrative body (e.g. County Board of Elections).", - "id": "AdministrativeBody", + "id": "CivicinfoSchemaV2AdministrativeBody", "properties": { "absenteeVotingInfoUrl": { "description": "A URL provided by this administrative body for information on absentee voting.", @@ -421,7 +636,7 @@ "type": "string" }, "correspondenceAddress": { - "$ref": "SimpleAddressType", + "$ref": "CivicinfoSchemaV2SimpleAddressType", "description": "The mailing address of this administrative body." }, "electionInfoUrl": { @@ -439,7 +654,7 @@ "electionOfficials": { "description": "The election officials for this election administrative body.", "items": { - "$ref": "ElectionOfficial" + "$ref": "CivicinfoSchemaV2ElectionOfficial" }, "type": "array" }, @@ -464,7 +679,7 @@ "type": "string" }, "physicalAddress": { - "$ref": "SimpleAddressType", + "$ref": "CivicinfoSchemaV2SimpleAddressType", "description": "The physical address of this administrative body." }, "voter_services": { @@ -481,9 +696,9 @@ }, "type": "object" }, - "Candidate": { + "CivicinfoSchemaV2Candidate": { "description": "Information about a candidate running for elected office.", - "id": "Candidate", + "id": "CivicinfoSchemaV2Candidate", "properties": { "candidateUrl": { "description": "The URL for the candidate's campaign web site.", @@ -492,7 +707,7 @@ "channels": { "description": "A list of known (social) media channels for this candidate.", "items": { - "$ref": "Channel" + "$ref": "CivicinfoSchemaV2Channel" }, "type": "array" }, @@ -524,9 +739,9 @@ }, "type": "object" }, - "Channel": { + "CivicinfoSchemaV2Channel": { "description": "A social media or web channel for a candidate.", - "id": "Channel", + "id": "CivicinfoSchemaV2Channel", "properties": { "id": { "description": "The unique public identifier for the candidate's channel.", @@ -539,9 +754,9 @@ }, "type": "object" }, - "Contest": { + "CivicinfoSchemaV2Contest": { "description": "Information about a contest that appears on a voter's ballot.", - "id": "Contest", + "id": "CivicinfoSchemaV2Contest", "properties": { "ballotPlacement": { "description": "A number specifying the position of this contest on the voter's ballot.", @@ -555,12 +770,12 @@ "candidates": { "description": "The candidate choices for this contest.", "items": { - "$ref": "Candidate" + "$ref": "CivicinfoSchemaV2Candidate" }, "type": "array" }, "district": { - "$ref": "ElectoralDistrict", + "$ref": "CivicinfoSchemaV2ElectoralDistrict", "description": "Information about the electoral district that this contest is in." }, "electorateSpecifications": { @@ -698,7 +913,7 @@ "sources": { "description": "A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.", "items": { - "$ref": "Source" + "$ref": "CivicinfoSchemaV2Source" }, "type": "array" }, @@ -713,65 +928,9 @@ }, "type": "object" }, - "DivisionByAddressResponse": { - "id": "DivisionByAddressResponse", - "properties": { - "divisions": { - "additionalProperties": { - "$ref": "GeographicDivision" - }, - "type": "object" - }, - "normalizedInput": { - "$ref": "SimpleAddressType", - "description": "The normalized version of the requested address." - } - }, - "type": "object" - }, - "DivisionSearchResponse": { - "description": "The result of a division search query.", - "id": "DivisionSearchResponse", - "properties": { - "kind": { - "default": "civicinfo#divisionSearchResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".", - "type": "string" - }, - "results": { - "items": { - "$ref": "DivisionSearchResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "DivisionSearchResult": { - "description": "Represents a political geographic division that matches the requested query.", - "id": "DivisionSearchResult", - "properties": { - "aliases": { - "description": "Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.", - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "The name of the division.", - "type": "string" - }, - "ocdId": { - "description": "The unique Open Civic Data identifier for this division", - "type": "string" - } - }, - "type": "object" - }, - "Election": { + "CivicinfoSchemaV2Election": { "description": "Information about the election that was queried.", - "id": "Election", + "id": "CivicinfoSchemaV2Election", "properties": { "electionDay": { "description": "Day of the election in YYYY-MM-DD format.", @@ -806,9 +965,9 @@ }, "type": "object" }, - "ElectionOfficial": { + "CivicinfoSchemaV2ElectionOfficial": { "description": "Information about individual election officials.", - "id": "ElectionOfficial", + "id": "CivicinfoSchemaV2ElectionOfficial", "properties": { "emailAddress": { "description": "The email address of the election official.", @@ -833,28 +992,9 @@ }, "type": "object" }, - "ElectionsQueryResponse": { - "description": "The list of elections available for this version of the API.", - "id": "ElectionsQueryResponse", - "properties": { - "elections": { - "description": "A list of available elections", - "items": { - "$ref": "Election" - }, - "type": "array" - }, - "kind": { - "default": "civicinfo#electionsQueryResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".", - "type": "string" - } - }, - "type": "object" - }, - "ElectoralDistrict": { + "CivicinfoSchemaV2ElectoralDistrict": { "description": "Describes the geographic scope of a contest.", - "id": "ElectoralDistrict", + "id": "CivicinfoSchemaV2ElectoralDistrict", "properties": { "id": { "description": "An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id \"34\" and a scope of stateUpper.", @@ -903,9 +1043,9 @@ }, "type": "object" }, - "GeographicDivision": { + "CivicinfoSchemaV2GeographicDivision": { "description": "Describes a political geography.", - "id": "GeographicDivision", + "id": "CivicinfoSchemaV2GeographicDivision", "properties": { "alsoKnownAs": { "description": "Any other valid OCD IDs that refer to the same division.\\n\\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\\n\\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.", @@ -929,9 +1069,9 @@ }, "type": "object" }, - "Office": { + "CivicinfoSchemaV2Office": { "description": "Information about an Office held by one or more Officials.", - "id": "Office", + "id": "CivicinfoSchemaV2Office", "properties": { "divisionId": { "description": "The OCD ID of the division with which this office is associated.", @@ -1016,28 +1156,28 @@ "sources": { "description": "A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.", "items": { - "$ref": "Source" + "$ref": "CivicinfoSchemaV2Source" }, "type": "array" } }, "type": "object" }, - "Official": { + "CivicinfoSchemaV2Official": { "description": "Information about a person holding an elected office.", - "id": "Official", + "id": "CivicinfoSchemaV2Official", "properties": { "address": { "description": "Addresses at which to contact the official.", "items": { - "$ref": "SimpleAddressType" + "$ref": "CivicinfoSchemaV2SimpleAddressType" }, "type": "array" }, "channels": { "description": "A list of known (social) media channels for this official.", "items": { - "$ref": "Channel" + "$ref": "CivicinfoSchemaV2Channel" }, "type": "array" }, @@ -1077,12 +1217,12 @@ }, "type": "object" }, - "PollingLocation": { + "CivicinfoSchemaV2PollingLocation": { "description": "A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.", - "id": "PollingLocation", + "id": "CivicinfoSchemaV2PollingLocation", "properties": { "address": { - "$ref": "SimpleAddressType", + "$ref": "CivicinfoSchemaV2SimpleAddressType", "description": "The address of the location." }, "endDate": { @@ -1114,7 +1254,7 @@ "sources": { "description": "A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.", "items": { - "$ref": "Source" + "$ref": "CivicinfoSchemaV2Source" }, "type": "array" }, @@ -1129,8 +1269,8 @@ }, "type": "object" }, - "Precinct": { - "id": "Precinct", + "CivicinfoSchemaV2Precinct": { + "id": "CivicinfoSchemaV2Precinct", "properties": { "administrationRegionId": { "description": "ID of the AdministrationRegion message for this precinct. Corresponds to LocalityId xml tag.", @@ -1210,73 +1350,9 @@ }, "type": "object" }, - "RepresentativeInfoData": { - "id": "RepresentativeInfoData", - "properties": { - "divisions": { - "additionalProperties": { - "$ref": "GeographicDivision" - }, - "description": "A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.", - "type": "object" - }, - "offices": { - "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.", - "items": { - "$ref": "Office" - }, - "type": "array" - }, - "officials": { - "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.", - "items": { - "$ref": "Official" - }, - "type": "array" - } - }, - "type": "object" - }, - "RepresentativeInfoResponse": { - "description": "The result of a representative info lookup query.", - "id": "RepresentativeInfoResponse", - "properties": { - "divisions": { - "additionalProperties": { - "$ref": "GeographicDivision" - }, - "description": "A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.", - "type": "object" - }, - "kind": { - "default": "civicinfo#representativeInfoResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#representativeInfoResponse\".", - "type": "string" - }, - "normalizedInput": { - "$ref": "SimpleAddressType", - "description": "The normalized version of the requested address" - }, - "offices": { - "description": "Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.", - "items": { - "$ref": "Office" - }, - "type": "array" - }, - "officials": { - "description": "Officials holding the offices listed above. Will only be present if includeOffices was true in the request.", - "items": { - "$ref": "Official" - }, - "type": "array" - } - }, - "type": "object" - }, - "SimpleAddressType": { + "CivicinfoSchemaV2SimpleAddressType": { "description": "A simple representation of an address.", - "id": "SimpleAddressType", + "id": "CivicinfoSchemaV2SimpleAddressType", "properties": { "city": { "description": "The city or town for the address.", @@ -1309,9 +1385,9 @@ }, "type": "object" }, - "Source": { + "CivicinfoSchemaV2Source": { "description": "Contains information about the data source for the element containing it.", - "id": "Source", + "id": "CivicinfoSchemaV2Source", "properties": { "name": { "description": "The name of the data source.", @@ -1323,82 +1399,6 @@ } }, "type": "object" - }, - "VoterInfoResponse": { - "description": "The result of a voter info lookup query.", - "id": "VoterInfoResponse", - "properties": { - "contests": { - "description": "Contests that will appear on the voter's ballot.", - "items": { - "$ref": "Contest" - }, - "type": "array" - }, - "dropOffLocations": { - "description": "Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.", - "items": { - "$ref": "PollingLocation" - }, - "type": "array" - }, - "earlyVoteSites": { - "description": "Locations where the voter is eligible to vote early, prior to election day.", - "items": { - "$ref": "PollingLocation" - }, - "type": "array" - }, - "election": { - "$ref": "Election", - "description": "The election that was queried." - }, - "kind": { - "default": "civicinfo#voterInfoResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#voterInfoResponse\".", - "type": "string" - }, - "mailOnly": { - "description": "Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).", - "type": "boolean" - }, - "normalizedInput": { - "$ref": "SimpleAddressType", - "description": "The normalized version of the requested address" - }, - "otherElections": { - "description": "When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user.", - "items": { - "$ref": "Election" - }, - "type": "array" - }, - "pollingLocations": { - "description": "Locations where the voter is eligible to vote on election day.", - "items": { - "$ref": "PollingLocation" - }, - "type": "array" - }, - "precinctId": { - "type": "string" - }, - "precincts": { - "description": "The precincts that match this voter's address. Will only be returned for project IDs which have been allowlisted as \"partner projects\".", - "items": { - "$ref": "Precinct" - }, - "type": "array" - }, - "state": { - "description": "Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.", - "items": { - "$ref": "AdministrationRegion" - }, - "type": "array" - } - }, - "type": "object" } }, "servicePath": "", diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index aa2aa0dd7d4..b3d81d4c99e 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -82,7 +82,7 @@ "batchPath": "batch", "description": "Manages classes, rosters, and invitations in Google Classroom.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/classroom/", + "documentationLink": "https://developers.google.com/workspace/classroom/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -242,6 +242,31 @@ "https://www.googleapis.com/auth/classroom.courses.readonly" ] }, + "getGradingPeriodSettings": { + "description": "Returns the grading period settings in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. * `NOT_FOUND` if the requested course does not exist.", + "flatPath": "v1/courses/{courseId}/gradingPeriodSettings", + "httpMethod": "GET", + "id": "classroom.courses.getGradingPeriodSettings", + "parameterOrder": [ + "courseId" + ], + "parameters": { + "courseId": { + "description": "Required. The identifier of the course.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/courses/{courseId}/gradingPeriodSettings", + "response": { + "$ref": "GradingPeriodSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.courses", + "https://www.googleapis.com/auth/classroom.courses.readonly" + ] + }, "list": { "description": "Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.", "flatPath": "v1/courses", @@ -361,6 +386,39 @@ "scopes": [ "https://www.googleapis.com/auth/classroom.courses" ] + }, + "updateGradingPeriodSettings": { + "description": "Updates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course owner must be eligible to modify Grading Periods. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for access errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", + "flatPath": "v1/courses/{courseId}/gradingPeriodSettings", + "httpMethod": "PATCH", + "id": "classroom.courses.updateGradingPeriodSettings", + "parameterOrder": [ + "courseId" + ], + "parameters": { + "courseId": { + "description": "Required. The identifier of the course.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/courses/{courseId}/gradingPeriodSettings", + "request": { + "$ref": "GradingPeriodSettings" + }, + "response": { + "$ref": "GradingPeriodSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.courses" + ] } }, "resources": { @@ -555,7 +613,7 @@ ] }, "getAddOnContext": { - "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", + "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "flatPath": "v1/courses/{courseId}/announcements/{itemId}/addOnContext", "httpMethod": "GET", "id": "classroom.courses.announcements.getAddOnContext", @@ -570,7 +628,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1073,7 +1131,7 @@ ] }, "getAddOnContext": { - "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", + "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{itemId}/addOnContext", "httpMethod": "GET", "id": "classroom.courses.courseWork.getAddOnContext", @@ -1088,7 +1146,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1238,7 +1296,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later.", + "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1256,7 +1314,7 @@ ] }, "updateRubric": { - "description": "Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.", + "description": "Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubric", "httpMethod": "PATCH", "id": "classroom.courses.courseWork.updateRubric", @@ -1663,7 +1721,7 @@ "rubrics": { "methods": { "create": { - "description": "Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`", + "description": "Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics", "httpMethod": "POST", "id": "classroom.courses.courseWork.rubrics.create", @@ -1697,7 +1755,7 @@ ] }, "delete": { - "description": "Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.", + "description": "Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "httpMethod": "DELETE", "id": "classroom.courses.courseWork.rubrics.delete", @@ -1821,7 +1879,7 @@ ] }, "patch": { - "description": "Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.", + "description": "Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}", "httpMethod": "PATCH", "id": "classroom.courses.courseWork.rubrics.patch", @@ -2313,7 +2371,7 @@ ] }, "getAddOnContext": { - "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", + "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "flatPath": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext", "httpMethod": "GET", "id": "classroom.courses.courseWorkMaterials.getAddOnContext", @@ -2328,7 +2386,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -2715,7 +2773,7 @@ "posts": { "methods": { "getAddOnContext": { - "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", + "description": "Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.", "flatPath": "v1/courses/{courseId}/posts/{postId}/addOnContext", "httpMethod": "GET", "id": "classroom.courses.posts.getAddOnContext", @@ -2730,7 +2788,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -3120,7 +3178,7 @@ "students": { "methods": { "create": { - "description": "Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.", + "description": "Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.", "flatPath": "v1/courses/{courseId}/students", "httpMethod": "POST", "id": "classroom.courses.students.create", @@ -3261,7 +3319,7 @@ "teachers": { "methods": { "create": { - "description": "Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course.", + "description": "Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course.", "flatPath": "v1/courses/{courseId}/teachers", "httpMethod": "POST", "id": "classroom.courses.teachers.create", @@ -4049,7 +4107,7 @@ } } }, - "revision": "20250303", + "revision": "20250420", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -4570,6 +4628,10 @@ "$ref": "GradeCategory", "description": "The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only." }, + "gradingPeriodId": { + "description": "Identifier of the grading period associated with the coursework. * At creation, if unspecified, the grading period ID will be set based on the `dueDate` (or `scheduledTime` if no `dueDate` is set). * To indicate no association to any grading period, set this field to an empty string (\"\"). * If specified, it must match an existing grading period ID in the course.", + "type": "string" + }, "id": { "description": "Classroom-assigned identifier of this course work, unique per course. Read-only.", "type": "string" @@ -5054,6 +5116,48 @@ }, "type": "object" }, + "GradingPeriod": { + "description": "An individual grading period. Grading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the end_date of a grading period is 2024-01-25, then the start_date of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course.", + "id": "GradingPeriod", + "properties": { + "endDate": { + "$ref": "Date", + "description": "Required. End date, in UTC, of the grading period. Inclusive." + }, + "id": { + "description": "Output only. System generated grading period ID. Read-only.", + "readOnly": true, + "type": "string" + }, + "startDate": { + "$ref": "Date", + "description": "Required. Start date, in UTC, of the grading period. Inclusive." + }, + "title": { + "description": "Required. Title of the grading period. For example, “Semester 1”.", + "type": "string" + } + }, + "type": "object" + }, + "GradingPeriodSettings": { + "description": "Grading period settings that include all the individual grading periods in a course.", + "id": "GradingPeriodSettings", + "properties": { + "applyToExistingCoursework": { + "description": "Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update `GradingPeriodSettings`. If not previously set, the default is False.", + "type": "boolean" + }, + "gradingPeriods": { + "description": "The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course.", + "items": { + "$ref": "GradingPeriod" + }, + "type": "array" + } + }, + "type": "object" + }, "Guardian": { "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work.", "id": "Guardian", @@ -5469,7 +5573,7 @@ }, "form": { "$ref": "Form", - "description": "Google Forms material." + "description": "Google Forms material. Read-only." }, "link": { "$ref": "Link", diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index caef4bf2d22..4b830c87746 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -86,6 +86,11 @@ "endpointUrl": "https://cloudbuild.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudbuild.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://cloudbuild.europe-southwest1.rep.googleapis.com/", @@ -2568,7 +2573,7 @@ } } }, - "revision": "20250303", + "revision": "20250418", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 393df92e629..195f1e64947 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -86,6 +86,11 @@ "endpointUrl": "https://cloudbuild.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudbuild.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://cloudbuild.europe-southwest1.rep.googleapis.com/", @@ -365,6 +370,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1076,7 +1087,7 @@ } } }, - "revision": "20250303", + "revision": "20250418", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/cloudchannel-v1.json b/discovery/cloudchannel-v1.json index bf69a4f661f..6ef5186266d 100644 --- a/discovery/cloudchannel-v1.json +++ b/discovery/cloudchannel-v1.json @@ -2289,7 +2289,7 @@ } } }, - "revision": "20241202", + "revision": "20250419", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -2430,7 +2430,7 @@ "type": "array" }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if populated in a request, this field isn't evaluated in the API.", + "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" }, "purchaseOrderId": { @@ -2866,6 +2866,20 @@ "readOnly": true, "type": "string" }, + "customerAttestationState": { + "description": "Optional. Indicate if a customer is attesting about the correctness of provided information. Only required if creating a GCP Entitlement.", + "enum": [ + "CUSTOMER_ATTESTATION_STATE_UNSPECIFIED", + "EXEMPT", + "NON_EXEMPT_AND_INFO_VERIFIED" + ], + "enumDescriptions": [ + "Default value if not set yet", + "Customer is exempt from attesting based on exemption list at https://cloud.google.com/terms/direct-tos-exemptions. Contact information of customer will be mandatory.", + "Customer is not exempt and has verified the information provided is correct. Contact information of customer will be mandatory." + ], + "type": "string" + }, "domain": { "description": "Required. The customer's primary domain. Must match the primary contact email's domain.", "type": "string" @@ -3109,7 +3123,7 @@ "type": "array" }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if this field is populated in a request, it isn't evaluated in the API.", + "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" }, "provisionedService": { @@ -3567,7 +3581,7 @@ "type": "string" }, "offers": { - "description": "The list of Offers requested.", + "description": "The list of Offers requested. The pricing information for each Offer only includes the base price. Effective prices and discounts aren't populated.", "items": { "$ref": "GoogleCloudChannelV1Offer" }, @@ -4326,7 +4340,7 @@ "description": "Offer." }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", + "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" } }, @@ -4902,7 +4916,7 @@ "description": "Offer with parameter constraints updated to allow the Transfer." }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", + "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" } }, @@ -5230,7 +5244,7 @@ "type": "array" }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if this field is populated in a request, it isn't evaluated in the API.", + "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" }, "provisionedService": { @@ -5408,18 +5422,24 @@ "enum": [ "TYPE_UNSPECIFIED", "CREATED", - "UPDATED" + "UPDATED", + "PARTNER_DETACHED" ], "enumDescriptions": [ "Not used.", "New opportunity created.", - "Existing opportunity updated." + "Existing opportunity updated.", + "Partner has been detached from the opportunity and can no longer access it." ], "type": "string" }, "opportunity": { "description": "Resource name of the opportunity. Format: opportunities/{opportunity}", "type": "string" + }, + "partner": { + "description": "Resource name of the partner. Format: partners/{partner}", + "type": "string" } }, "type": "object" @@ -5962,18 +5982,18 @@ "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", + "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 or 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).", + "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 or 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). In 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.", + "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. 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": { @@ -5981,7 +6001,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -5989,7 +6009,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -6009,11 +6029,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index 44b1e0de994..c33a827416a 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2348,7 +2354,7 @@ } } }, - "revision": "20250226", + "revision": "20250416", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -3040,7 +3046,7 @@ "description": "Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase." }, "verify": { - "description": "Optional. Whether to run verify tests after each percentage deployment.", + "description": "Optional. Whether to run verify tests after each percentage deployment via `skaffold verify`.", "type": "boolean" } }, @@ -3741,7 +3747,7 @@ "type": "string" }, "etag": { - "description": "The weak etag of the `Automation` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "The weak etag of the `DeployPolicy` resource. 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" }, "labels": { @@ -4959,7 +4965,7 @@ "type": "array" }, "verify": { - "description": "Optional. Whether to run verify tests after the deployment.", + "description": "Optional. Whether to run verify tests after the deployment via `skaffold verify`.", "type": "boolean" } }, @@ -6672,14 +6678,14 @@ "properties": { "postdeploy": { "$ref": "Postdeploy", - "description": "Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present." + "description": "Optional. Configuration for the postdeploy job. If this is not configured, the postdeploy job will not be present." }, "predeploy": { "$ref": "Predeploy", - "description": "Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present." + "description": "Optional. Configuration for the predeploy job. If this is not configured, the predeploy job will not be present." }, "verify": { - "description": "Optional. Whether to verify a deployment.", + "description": "Optional. Whether to verify a deployment via `skaffold verify`.", "type": "boolean" } }, diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 3561ae2b485..40494ab1f68 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -184,6 +184,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -552,7 +558,7 @@ } } }, - "revision": "20250124", + "revision": "20250424", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -704,7 +710,7 @@ }, "dockerRegistry": { "deprecated": true, - "description": "Docker Registry to use for this deployment. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", + "description": "Docker Registry to use for this deployment. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", "enum": [ "DOCKER_REGISTRY_UNSPECIFIED", "CONTAINER_REGISTRY", diff --git a/discovery/cloudfunctions-v2.json b/discovery/cloudfunctions-v2.json index adc24dd5a0e..149c214da66 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -118,6 +118,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -744,7 +750,7 @@ } } }, - "revision": "20250228", + "revision": "20250424", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -843,7 +849,7 @@ }, "dockerRegistry": { "deprecated": true, - "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", + "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", "enum": [ "DOCKER_REGISTRY_UNSPECIFIED", "CONTAINER_REGISTRY", @@ -1988,7 +1994,12 @@ "SetupFunctionUpgradeConfigRequest": { "description": "Request for the `SetupFunctionUpgradeConfig` method.", "id": "SetupFunctionUpgradeConfigRequest", - "properties": {}, + "properties": { + "triggerServiceAccount": { + "description": "Optional. The trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.", + "type": "string" + } + }, "type": "object" }, "Source": { diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index 340352a54d4..b5ddee36038 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -118,6 +118,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -744,7 +750,7 @@ } } }, - "revision": "20250228", + "revision": "20250424", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -843,7 +849,7 @@ }, "dockerRegistry": { "deprecated": true, - "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", + "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", "enum": [ "DOCKER_REGISTRY_UNSPECIFIED", "CONTAINER_REGISTRY", @@ -1988,7 +1994,12 @@ "SetupFunctionUpgradeConfigRequest": { "description": "Request for the `SetupFunctionUpgradeConfig` method.", "id": "SetupFunctionUpgradeConfigRequest", - "properties": {}, + "properties": { + "triggerServiceAccount": { + "description": "Optional. The trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.", + "type": "string" + } + }, "type": "object" }, "Source": { diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index 0dc67424869..9eeea93a0a3 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -118,6 +118,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -744,7 +750,7 @@ } } }, - "revision": "20250228", + "revision": "20250424", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -843,7 +849,7 @@ }, "dockerRegistry": { "deprecated": true, - "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", + "description": "Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.", "enum": [ "DOCKER_REGISTRY_UNSPECIFIED", "CONTAINER_REGISTRY", @@ -1988,7 +1994,12 @@ "SetupFunctionUpgradeConfigRequest": { "description": "Request for the `SetupFunctionUpgradeConfig` method.", "id": "SetupFunctionUpgradeConfigRequest", - "properties": {}, + "properties": { + "triggerServiceAccount": { + "description": "Optional. The trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.", + "type": "string" + } + }, "type": "object" }, "Source": { diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index 8d03b06ede4..e03bd09dd0a 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -382,6 +382,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2152,7 +2158,7 @@ } } }, - "revision": "20250227", + "revision": "20250414", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/discovery/cloudresourcemanager-v2.json b/discovery/cloudresourcemanager-v2.json index bf0506547a2..d085efac408 100644 --- a/discovery/cloudresourcemanager-v2.json +++ b/discovery/cloudresourcemanager-v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20240310", + "revision": "20250417", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -705,6 +705,14 @@ "description": "A Folder in an Organization's resource hierarchy, used to organize that Organization's resources.", "id": "Folder", "properties": { + "configuredCapabilities": { + "description": "Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "createTime": { "description": "Output only. Timestamp when the Folder was created. Assigned by the server.", "format": "google-datetime", @@ -730,6 +738,11 @@ "readOnly": true, "type": "string" }, + "managementProject": { + "description": "Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY.", + "readOnly": true, + "type": "string" + }, "name": { "description": "Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".", "readOnly": true, diff --git a/discovery/cloudresourcemanager-v2beta1.json b/discovery/cloudresourcemanager-v2beta1.json index 00a6dc248df..073c7384f89 100644 --- a/discovery/cloudresourcemanager-v2beta1.json +++ b/discovery/cloudresourcemanager-v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20240310", + "revision": "20250417", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -705,6 +705,14 @@ "description": "A Folder in an Organization's resource hierarchy, used to organize that Organization's resources.", "id": "Folder", "properties": { + "configuredCapabilities": { + "description": "Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "createTime": { "description": "Output only. Timestamp when the Folder was created. Assigned by the server.", "format": "google-datetime", @@ -730,6 +738,11 @@ "readOnly": true, "type": "string" }, + "managementProject": { + "description": "Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY.", + "readOnly": true, + "type": "string" + }, "name": { "description": "Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".", "readOnly": true, diff --git a/discovery/cloudresourcemanager-v3.json b/discovery/cloudresourcemanager-v3.json index 0460bf1a709..5408b0821a4 100644 --- a/discovery/cloudresourcemanager-v3.json +++ b/discovery/cloudresourcemanager-v3.json @@ -462,6 +462,71 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "capabilities": { + "methods": { + "get": { + "description": "Retrieves the Capability identified by the supplied resource name.", + "flatPath": "v3/folders/{foldersId}/capabilities/{capabilitiesId}", + "httpMethod": "GET", + "id": "cloudresourcemanager.folders.capabilities.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`", + "location": "path", + "pattern": "^folders/[^/]+/capabilities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "Capability" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the Capability.", + "flatPath": "v3/folders/{foldersId}/capabilities/{capabilitiesId}", + "httpMethod": "PATCH", + "id": "cloudresourcemanager.folders.capabilities.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`", + "location": "path", + "pattern": "^folders/[^/]+/capabilities/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. Only [Capability.value] can be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "Capability" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "liens": { @@ -1805,7 +1870,7 @@ } } }, - "revision": "20250206", + "revision": "20250417", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1878,6 +1943,21 @@ }, "type": "object" }, + "Capability": { + "description": "Representation of a Capability.", + "id": "Capability", + "properties": { + "name": { + "description": "Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`", + "type": "string" + }, + "value": { + "description": "Required. The configured value of the capability at the given parent resource.", + "type": "boolean" + } + }, + "type": "object" + }, "CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation": { "description": "Metadata describing a long running folder operation", "id": "CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation", @@ -2097,6 +2177,14 @@ "description": "A folder in an organization's resource hierarchy, used to organize that organization's resources.", "id": "Folder", "properties": { + "configuredCapabilities": { + "description": "Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "createTime": { "description": "Output only. Timestamp when the folder was created.", "format": "google-datetime", @@ -2118,6 +2206,11 @@ "readOnly": true, "type": "string" }, + "managementProject": { + "description": "Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY.", + "readOnly": true, + "type": "string" + }, "name": { "description": "Output only. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".", "readOnly": true, diff --git a/discovery/cloudscheduler-v1.json b/discovery/cloudscheduler-v1.json index 806b13083ff..8b881818966 100644 --- a/discovery/cloudscheduler-v1.json +++ b/discovery/cloudscheduler-v1.json @@ -254,6 +254,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -529,7 +535,7 @@ } } }, - "revision": "20241203", + "revision": "20250411", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/discovery/cloudscheduler-v1beta1.json b/discovery/cloudscheduler-v1beta1.json index 96872335413..8406f13e10d 100644 --- a/discovery/cloudscheduler-v1beta1.json +++ b/discovery/cloudscheduler-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -433,7 +439,7 @@ } } }, - "revision": "20241113", + "revision": "20250411", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/discovery/cloudtasks-v2.json b/discovery/cloudtasks-v2.json index 79381c189b0..1ae8047f865 100644 --- a/discovery/cloudtasks-v2.json +++ b/discovery/cloudtasks-v2.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -779,7 +785,7 @@ } } }, - "revision": "20250115", + "revision": "20250411", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { diff --git a/discovery/cloudtasks-v2beta2.json b/discovery/cloudtasks-v2beta2.json index 5da1ff6b943..3aa084f7260 100644 --- a/discovery/cloudtasks-v2beta2.json +++ b/discovery/cloudtasks-v2beta2.json @@ -200,6 +200,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -935,7 +941,7 @@ } } }, - "revision": "20240808", + "revision": "20250411", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { diff --git a/discovery/cloudtasks-v2beta3.json b/discovery/cloudtasks-v2beta3.json index e7a554f5bda..2d40a4663ab 100644 --- a/discovery/cloudtasks-v2beta3.json +++ b/discovery/cloudtasks-v2beta3.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -791,7 +797,7 @@ } } }, - "revision": "20250115", + "revision": "20250411", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { diff --git a/discovery/cloudtrace-v1.json b/discovery/cloudtrace-v1.json index ceed88c8499..900001ac476 100644 --- a/discovery/cloudtrace-v1.json +++ b/discovery/cloudtrace-v1.json @@ -114,7 +114,7 @@ "projects": { "methods": { "patchTraces": { - "description": "Sends new traces to Cloud Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.", + "description": "Sends trace spans to Cloud Trace. Spans cannot be updated. If the trace ID and span ID already exist, an additional copy of the span will be stored.", "flatPath": "v1/projects/{projectId}/traces", "httpMethod": "PATCH", "id": "cloudtrace.projects.patchTraces", @@ -257,7 +257,7 @@ } } }, - "revision": "20240816", + "revision": "20250411", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/cloudtrace-v2.json b/discovery/cloudtrace-v2.json index 0df1cf8917b..57878bc8c73 100644 --- a/discovery/cloudtrace-v2.json +++ b/discovery/cloudtrace-v2.json @@ -113,7 +113,7 @@ "traces": { "methods": { "batchWrite": { - "description": "Batch writes new spans to new or existing traces. You cannot update existing spans.", + "description": "Batch writes new spans to new or existing traces. You cannot update existing spans. If a span ID already exists, an additional copy of the span will be stored.", "flatPath": "v2/projects/{projectsId}/traces:batchWrite", "httpMethod": "POST", "id": "cloudtrace.projects.traces.batchWrite", @@ -146,7 +146,7 @@ "spans": { "methods": { "createSpan": { - "description": "Creates a new span.", + "description": "Creates a new span. If a span ID already exists, an additional copy of the span will be stored.", "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}", "httpMethod": "POST", "id": "cloudtrace.projects.traces.spans.createSpan", @@ -181,7 +181,7 @@ } } }, - "revision": "20230608", + "revision": "20250411", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 37b10adbb39..3b82f49a084 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -16835,44 +16835,6 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/global/interconnectLocations/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.interconnectLocations.testIamPermissions", - "parameterOrder": [ - "project", - "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" - } - }, - "path": "projects/{project}/global/interconnectLocations/{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" - ] } } }, @@ -16967,44 +16929,6 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/global/interconnectRemoteLocations/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.interconnectRemoteLocations.testIamPermissions", - "parameterOrder": [ - "project", - "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" - } - }, - "path": "projects/{project}/global/interconnectRemoteLocations/{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" - ] } } }, @@ -18177,6 +18101,43 @@ "https://www.googleapis.com/auth/compute" ] }, + "setLabels": { + "description": "Sets the labels on a machine image. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/global/machineImages/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.machineImages.setLabels", + "parameterOrder": [ + "project", + "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" + } + }, + "path": "projects/{project}/global/machineImages/{resource}/setLabels", + "request": { + "$ref": "GlobalSetLabelsRequest" + }, + "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}/global/machineImages/{resource}/testIamPermissions", @@ -21243,6 +21204,48 @@ "https://www.googleapis.com/auth/compute" ] }, + "requestRemovePeering": { + "description": "Requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS.", + "flatPath": "projects/{project}/global/networks/{network}/requestRemovePeering", + "httpMethod": "POST", + "id": "compute.networks.requestRemovePeering", + "parameterOrder": [ + "project", + "network" + ], + "parameters": { + "network": { + "description": "Name of the network resource to remove peering from.", + "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" + } + }, + "path": "projects/{project}/global/networks/{network}/requestRemovePeering", + "request": { + "$ref": "NetworksRequestRemovePeeringRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "switchToCustomMode": { "description": "Switches the network mode from auto subnet mode to custom subnet mode.", "flatPath": "projects/{project}/global/networks/{network}/switchToCustomMode", @@ -23660,6 +23663,142 @@ } } }, + "previewFeatures": { + "methods": { + "get": { + "description": "Returns the details of the given PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures/{resourceId}", + "httpMethod": "GET", + "id": "compute.previewFeatures.get", + "parameterOrder": [ + "project", + "resourceId" + ], + "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" + }, + "resourceId": { + "description": "Name of the PreviewFeature 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}/global/previewFeatures/{resourceId}", + "response": { + "$ref": "PreviewFeature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Returns the details of the given PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures", + "httpMethod": "GET", + "id": "compute.previewFeatures.list", + "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/previewFeatures", + "response": { + "$ref": "PreviewFeatureList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures/{resourceId}", + "httpMethod": "PATCH", + "id": "compute.previewFeatures.update", + "parameterOrder": [ + "project", + "resourceId" + ], + "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" + }, + "resourceId": { + "description": "Name of the PreviewFeature 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}/global/previewFeatures/{resourceId}", + "request": { + "$ref": "PreviewFeature" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "projects": { "methods": { "disableXpnHost": { @@ -37316,48 +37455,36 @@ } } }, - "reservationBlocks": { + "reliabilityRisks": { "methods": { "get": { - "description": "Retrieves information about the specified reservation block.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", + "description": "Returns the specified ReliabilityRisk resource.", + "flatPath": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", "httpMethod": "GET", - "id": "compute.reservationBlocks.get", + "id": "compute.reliabilityRisks.get", "parameterOrder": [ "project", - "zone", - "reservation", - "reservationBlock" + "reliabilityRisk" ], "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": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", - "location": "path", - "required": true, - "type": "string" - }, - "reservationBlock": { - "description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", - "location": "path", - "required": true, - "type": "string" - }, - "zone": { - "description": "Name of the zone for this request. Zone name should conform to RFC1035.", + "reliabilityRisk": { + "description": "Name of the ReliabilityRisk 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}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", + "path": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", "response": { - "$ref": "ReservationBlocksGetResponse" + "$ref": "ReliabilityRisk" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -37366,14 +37493,120 @@ ] }, "list": { - "description": "Retrieves a list of reservation blocks under a single reservation.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "description": "Retrieves the list of reliabilityRisks available in the specified project.", + "flatPath": "projects/{project}/global/reliabilityRisks", "httpMethod": "GET", - "id": "compute.reservationBlocks.list", + "id": "compute.reliabilityRisks.list", "parameterOrder": [ - "project", - "zone", - "reservation" + "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/reliabilityRisks", + "response": { + "$ref": "ReliabilityRisksListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "reservationBlocks": { + "methods": { + "get": { + "description": "Retrieves information about the specified reservation block.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", + "httpMethod": "GET", + "id": "compute.reservationBlocks.get", + "parameterOrder": [ + "project", + "zone", + "reservation", + "reservationBlock" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "required": true, + "type": "string" + }, + "reservation": { + "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "reservationBlock": { + "description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "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}", + "response": { + "$ref": "ReservationBlocksGetResponse" + }, + "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 reservation blocks under a single reservation.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "httpMethod": "GET", + "id": "compute.reservationBlocks.list", + "parameterOrder": [ + "project", + "zone", + "reservation" ], "parameters": { "filter": { @@ -37459,14 +37692,12 @@ "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" }, @@ -37491,6 +37722,176 @@ } } }, + "reservationSubBlocks": { + "methods": { + "get": { + "description": "Retrieves information about the specified reservation subBlock.", + "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", + "httpMethod": "GET", + "id": "compute.reservationSubBlocks.get", + "parameterOrder": [ + "project", + "zone", + "parentName", + "reservationSubBlock" + ], + "parameters": { + "parentName": { + "description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "required": true, + "type": "string" + }, + "reservationSubBlock": { + "description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "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}/{parentName}/reservationSubBlocks/{reservationSubBlock}", + "response": { + "$ref": "ReservationSubBlocksGetResponse" + }, + "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 reservation subBlocks under a single reservation.", + "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", + "httpMethod": "GET", + "id": "compute.reservationSubBlocks.list", + "parameterOrder": [ + "project", + "zone", + "parentName" + ], + "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" + }, + "parentName": { + "description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "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. Zone name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", + "response": { + "$ref": "ReservationSubBlocksListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "performMaintenance": { + "description": "Allows customers to perform maintenance on a reservation subBlock", + "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", + "httpMethod": "POST", + "id": "compute.reservationSubBlocks.performMaintenance", + "parameterOrder": [ + "project", + "zone", + "parentName", + "reservationSubBlock" + ], + "parameters": { + "parentName": { + "description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", + "location": "path", + "required": true, + "type": "string" + }, + "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" + }, + "reservationSubBlock": { + "description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "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}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "reservations": { "methods": { "aggregatedList": { @@ -40752,6 +41153,11 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "showNatIps": { + "description": "Indicates whether NAT IPs should be included in the response.", + "location": "query", + "type": "boolean" } }, "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", @@ -41059,6 +41465,289 @@ } } }, + "snapshotGroups": { + "methods": { + "delete": { + "description": "Deletes the specified SnapshotGroup resource", + "flatPath": "projects/{project}/global/snapshotGroups/{snapshotGroup}", + "httpMethod": "DELETE", + "id": "compute.snapshotGroups.delete", + "parameterOrder": [ + "project", + "snapshotGroup" + ], + "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" + }, + "snapshotGroup": { + "description": "Name of the SnapshotGroup 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/snapshotGroups/{snapshotGroup}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "returns the specified SnapshotGroup resource.", + "flatPath": "projects/{project}/global/snapshotGroups/{snapshotGroup}", + "httpMethod": "GET", + "id": "compute.snapshotGroups.get", + "parameterOrder": [ + "project", + "snapshotGroup" + ], + "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" + }, + "snapshotGroup": { + "description": "Name of the SnapshotGroup 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/snapshotGroups/{snapshotGroup}", + "response": { + "$ref": "SnapshotGroup" + }, + "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}/global/snapshotGroups/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.snapshotGroups.getIamPolicy", + "parameterOrder": [ + "project", + "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" + } + }, + "path": "projects/{project}/global/snapshotGroups/{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 group in the specified project using the data included in the request.", + "flatPath": "projects/{project}/global/snapshotGroups", + "httpMethod": "POST", + "id": "compute.snapshotGroups.insert", + "parameterOrder": [ + "project" + ], + "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" + } + }, + "path": "projects/{project}/global/snapshotGroups", + "request": { + "$ref": "SnapshotGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "retrieves the list of SnapshotGroup resources contained within the specified project.", + "flatPath": "projects/{project}/global/snapshotGroups", + "httpMethod": "GET", + "id": "compute.snapshotGroups.list", + "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/snapshotGroups", + "response": { + "$ref": "ListSnapshotGroups" + }, + "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}/global/snapshotGroups/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.snapshotGroups.setIamPolicy", + "parameterOrder": [ + "project", + "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" + } + }, + "path": "projects/{project}/global/snapshotGroups/{resource}/setIamPolicy", + "request": { + "$ref": "GlobalSetPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "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}/global/snapshotGroups/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.snapshotGroups.testIamPermissions", + "parameterOrder": [ + "project", + "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" + } + }, + "path": "projects/{project}/global/snapshotGroups/{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" + ] + } + } + }, "snapshotSettings": { "methods": { "get": { @@ -43105,6 +43794,20 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "views": { + "description": "Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. ", + "enum": [ + "DEFAULT", + "WITH_UTILIZATION" + ], + "enumDescriptions": [ + "", + "Utilization data is included in the response." + ], + "location": "query", + "repeated": true, + "type": "string" } }, "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", @@ -43259,6 +43962,20 @@ "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" + }, + "views": { + "description": "Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. ", + "enum": [ + "DEFAULT", + "WITH_UTILIZATION" + ], + "enumDescriptions": [ + "", + "Utilization data is included in the response." + ], + "location": "query", + "repeated": true, + "type": "string" } }, "path": "projects/{project}/regions/{region}/subnetworks", @@ -48017,7 +48734,6 @@ "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" }, @@ -48036,7 +48752,6 @@ "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" } @@ -48063,7 +48778,6 @@ "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" }, @@ -48077,7 +48791,6 @@ "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" } @@ -48104,7 +48817,6 @@ "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" }, @@ -48150,7 +48862,6 @@ "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" }, @@ -48213,7 +48924,6 @@ "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" }, @@ -48243,7 +48953,6 @@ "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" } @@ -48859,7 +49568,7 @@ } } }, - "revision": "20250304", + "revision": "20250427", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -51730,7 +52439,7 @@ "type": "boolean" }, "group": { - "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.", + "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP.", "type": "string" }, "maxConnections": { @@ -51845,9 +52554,11 @@ "loadBalancingScheme": { "description": "The value can only be INTERNAL_MANAGED for cross-region internal layer 7 load balancer. If loadBalancingScheme is not specified, the backend bucket can be used by classic global external load balancers, or global application external load balancers, or both.", "enum": [ + "EXTERNAL_MANAGED", "INTERNAL_MANAGED" ], "enumDescriptions": [ + "Signifies that this will be used for regional external Application Load Balancers.", "Signifies that this will be used for internal Application Load Balancers." ], "type": "string" @@ -51912,7 +52623,7 @@ "type": "integer" }, "defaultTtl": { - "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "format": "int32", "type": "integer" }, @@ -51937,7 +52648,7 @@ "type": "boolean" }, "serveWhileStale": { - "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", + "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "format": "int32", "type": "integer" }, @@ -52380,15 +53091,16 @@ "type": "string" }, "connectionDraining": { - "$ref": "ConnectionDraining" + "$ref": "ConnectionDraining", + "description": "connectionDraining cannot be specified with haPolicy." }, "connectionTrackingPolicy": { "$ref": "BackendServiceConnectionTrackingPolicy", - "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers." + "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy." }, "consistentHash": { "$ref": "ConsistentHashLoadBalancerSettings", - "description": "Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. " + "description": "Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. " }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", @@ -52452,7 +53164,7 @@ }, "failoverPolicy": { "$ref": "BackendServiceFailoverPolicy", - "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview)." + "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy." }, "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.", @@ -52461,10 +53173,10 @@ }, "haPolicy": { "$ref": "BackendServiceHAPolicy", - "description": "Configuring haPolicy is not supported." + "description": "Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers." }, "healthChecks": { - "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.", + "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.", "items": { "type": "string" }, @@ -52528,7 +53240,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -52574,16 +53286,16 @@ "type": "string" }, "network": { - "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.", + "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. 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." + "description": "Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy." }, "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." + "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, HTTP2 or H2C, 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." }, "port": { "deprecated": true, @@ -52596,7 +53308,7 @@ "type": "string" }, "protocol": { - "description": "The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.", + "description": "The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.", "enum": [ "ALL", "GRPC", @@ -52655,7 +53367,7 @@ "type": "string" }, "sessionAffinity": { - "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).", + "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy.", "enum": [ "CLIENT_IP", "CLIENT_IP_NO_DESTINATION", @@ -52685,7 +53397,8 @@ "description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY." }, "subsetting": { - "$ref": "Subsetting" + "$ref": "Subsetting", + "description": "subsetting cannot be specified with haPolicy." }, "timeoutSec": { "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.", @@ -52918,7 +53631,7 @@ "type": "integer" }, "defaultTtl": { - "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "format": "int32", "type": "integer" }, @@ -52943,7 +53656,7 @@ "type": "boolean" }, "serveWhileStale": { - "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", + "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "format": "int32", "type": "integer" }, @@ -53120,7 +53833,7 @@ "id": "BackendServiceHAPolicy", "properties": { "fastIPMove": { - "description": "Enabling fastIPMove is not supported.", + "description": "Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to update the leader. - >GARP_RA: Provides a method to very quickly define a new network endpoint as the leader. This method is faster than updating the leader using the haPolicy.leader API. Fast IP move works as follows: The VM hosting the network endpoint that should become the new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays active for approximately 20 minutes. After triggering fast failover, you must also appropriately set the haPolicy.leader. - The new leader instance should continue to send GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from different VM instances at the same time. If multiple instances continue to send GARP/RA packets, traffic might be routed to different destinations in an alternating order. This condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always takes priority over the leader API. Using the haPolicy.leader API to change the leader to a different instance will have no effect until the GARP/RA request becomes inactive. - The GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding rules refer to a regional backend service, you need only send a GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend service will also be moved to the sender of the GARP or RA packet. The following are the Fast IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED.", "enum": [ "DISABLED", "GARP_RA" @@ -53133,7 +53846,7 @@ }, "leader": { "$ref": "BackendServiceHAPolicyLeader", - "description": "Setting a leader is not supported." + "description": "Selects one of the network endpoints attached to the backend NEGs of this service as the active endpoint (the leader) that receives all traffic. When the leader changes, there is no connection draining to persist existing connections on the old leader. You are responsible for selecting a suitable endpoint as the leader. For example, preferring a healthy endpoint over unhealthy ones. Note that this service does not track backend endpoint health, and selects the configured leader unconditionally." } }, "type": "object" @@ -53142,12 +53855,12 @@ "id": "BackendServiceHAPolicyLeader", "properties": { "backendGroup": { - "description": "Setting backendGroup is not supported.", + "description": "A fully-qualified URL (starting with https://www.googleapis.com/) of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints that the leader is attached to. The leader's backendGroup must already be specified as a backend of this backend service. Removing a backend that is designated as the leader's backendGroup is not permitted.", "type": "string" }, "networkEndpoint": { "$ref": "BackendServiceHAPolicyLeaderNetworkEndpoint", - "description": "Setting a network endpoint as leader is not supported." + "description": "The network endpoint within the leader.backendGroup that is designated as the leader. This network endpoint cannot be detached from the NEG specified in the haPolicy.leader.backendGroup until the leader is updated with another network endpoint, or the leader is removed from the haPolicy." } }, "type": "object" @@ -53156,7 +53869,7 @@ "id": "BackendServiceHAPolicyLeaderNetworkEndpoint", "properties": { "instance": { - "description": "Specifying the instance name of a leader is not supported.", + "description": "The name of the VM instance of the leader network endpoint. The instance must already be attached to the NEG specified in the haPolicy.leader.backendGroup. The name must be 1-63 characters long, and comply with RFC1035. Authorization requires the following IAM permission on the specified resource instance: compute.instances.use", "type": "string" } }, @@ -54267,6 +54980,14 @@ "description": "A transient resource used in compute.disks.bulkInsert and compute.regionDisks.bulkInsert. It is only used to process requests and is not persisted.", "id": "BulkInsertDiskResource", "properties": { + "instantSnapshotGroupParameters": { + "$ref": "InstantSnapshotGroupParameters", + "description": "The parameters for the instant snapshot group." + }, + "snapshotGroupParameters": { + "$ref": "SnapshotGroupParameters", + "description": "The parameters for the snapshot group." + }, "sourceConsistencyGroupPolicy": { "description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to clone. This may be a full or partial URL, such as: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", "type": "string" @@ -54420,7 +55141,7 @@ "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.", + "description": "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" }, @@ -54805,14 +55526,17 @@ "ACCELERATOR_OPTIMIZED_A3_MEGA", "ACCELERATOR_OPTIMIZED_A3_ULTRA", "ACCELERATOR_OPTIMIZED_A4", + "ACCELERATOR_OPTIMIZED_A4X", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", + "COMPUTE_OPTIMIZED_H4D", "GENERAL_PURPOSE", "GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_C4A", + "GENERAL_PURPOSE_C4D", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -54822,6 +55546,7 @@ "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", "MEMORY_OPTIMIZED_M4", + "MEMORY_OPTIMIZED_M4_6TB", "MEMORY_OPTIMIZED_X4", "MEMORY_OPTIMIZED_X4_16TB", "MEMORY_OPTIMIZED_X4_24TB", @@ -54857,6 +55582,10 @@ "", "", "", + "", + "", + "", + "", "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" @@ -56338,6 +57067,28 @@ }, "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" + }, "DeprecationStatus": { "description": "Deprecation status for a public resource.", "id": "DeprecationStatus", @@ -58686,6 +59437,10 @@ "description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default ", "type": "string" }, + "params": { + "$ref": "FirewallParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "priority": { "description": "Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.", "format": "int32", @@ -58915,6 +59670,20 @@ }, "type": "object" }, + "FirewallParams": { + "description": "Additional firewall parameters.", + "id": "FirewallParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "FirewallPoliciesListAssociationsResponse": { "id": "FirewallPoliciesListAssociationsResponse", "properties": { @@ -59125,6 +59894,18 @@ "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" }, + "policyType": { + "description": "The type of the firewall policy. This field can be either VPC_POLICY or RDMA_ROCE_POLICY. Note: if not specified then VPC_POLICY will be used.", + "enum": [ + "RDMA_ROCE_POLICY", + "VPC_POLICY" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "region": { "description": "[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. 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" @@ -59410,6 +60191,13 @@ "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.", "type": "string" }, + "targetForwardingRules": { + "description": "A list of forwarding rules to which this rule applies. This field allows you to control which load balancers get this rule. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/forwardingRules/forwardingRule - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - projects/project/global/ forwardingRules/forwardingRule - projects/project/regions/region/forwardingRules/ forwardingRule ", + "items": { + "type": "string" + }, + "type": "array" + }, "targetResources": { "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.", "items": { @@ -59431,6 +60219,18 @@ }, "type": "array" }, + "targetType": { + "description": "Target types of the firewall policy rule. Default value is INSTANCES.", + "enum": [ + "INSTANCES", + "INTERNAL_MANAGED_LB" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "tlsInspect": { "description": "Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.", "type": "boolean" @@ -59481,6 +60281,24 @@ ], "type": "string" }, + "destNetworkType": { + "description": "Network type of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET ", + "enum": [ + "INTERNET", + "INTRA_VPC", + "NON_INTERNET", + "UNSPECIFIED", + "VPC_NETWORKS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, "destRegionCodes": { "description": "Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.\"US\" Maximum number of dest region codes allowed is 5000.", "items": { @@ -59541,6 +60359,24 @@ ], "type": "string" }, + "srcNetworkType": { + "description": "Network type of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS ", + "enum": [ + "INTERNET", + "INTRA_VPC", + "NON_INTERNET", + "UNSPECIFIED", + "VPC_NETWORKS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, "srcNetworks": { "description": "Networks of the traffic source. It can be either a full or partial url.", "items": { @@ -60463,6 +61299,10 @@ "description": "An optional description of this resource. Provide this property when you create the future reservation.", "type": "string" }, + "enableEmergentMaintenance": { + "description": "Indicates if this group of VMs have emergent maintenance enabled.", + "type": "boolean" + }, "id": { "description": "[Output Only] A unique identifier for this future reservation. The server defines this identifier.", "format": "uint64", @@ -61757,6 +62597,16 @@ ], "type": "string" }, + "subblockInfraMaintenanceOngoingCount": { + "description": "Describes number of subblock Infrastructure that has ongoing maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family(e.g. NVLink Domains). Not all VM Families will support this field.", + "format": "int32", + "type": "integer" + }, + "subblockInfraMaintenancePendingCount": { + "description": "Describes number of subblock Infrastructure that has pending maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family (e.g. NVLink Domains). Not all VM Families will support this field.", + "format": "int32", + "type": "integer" + }, "upcomingGroupMaintenance": { "$ref": "UpcomingMaintenance", "description": "Maintenance information on this group of VMs." @@ -61852,7 +62702,7 @@ "id": "GuestOsFeature", "properties": { "type": { - "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", + "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", "FEATURE_TYPE_UNSPECIFIED", @@ -61864,6 +62714,7 @@ "SEV_LIVE_MIGRATABLE", "SEV_LIVE_MIGRATABLE_V2", "SEV_SNP_CAPABLE", + "SNP_SVSM_CAPABLE", "TDX_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", @@ -61883,6 +62734,7 @@ "", "", "", + "", "" ], "type": "string" @@ -67227,7 +68079,7 @@ "type": "string" }, "instances": { - "description": "The list of specifications of per-instance configs to be created. This field cannot be used together with 'resize_by'.", + "description": "The names of instances to be created by this resize request. The number of names specified determines the number of instances to create. The group's target size will be increased by this number. This field cannot be used together with 'resize_by'.", "items": { "$ref": "PerInstanceConfig" }, @@ -70255,7 +71107,7 @@ "type": "string" }, "disruptionSchedule": { - "description": "The disruption schedule for the VM. Default to IMMEDIATE.", + "description": "The disruption schedule for the VM. Required field, only allows IMMEDIATE.", "enum": [ "DISRUPTION_SCHEDULE_UNSPECIFIED", "FUTURE", @@ -70932,6 +71784,16 @@ }, "type": "object" }, + "InstantSnapshotGroupParameters": { + "id": "InstantSnapshotGroupParameters", + "properties": { + "sourceInstantSnapshotGroup": { + "description": "The source instant snapshot group used to create disks. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshotGroups/instantSnapshotGroup - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup - zones/zone/instantSnapshotGroups/instantSnapshotGroup ", + "type": "string" + } + }, + "type": "object" + }, "InstantSnapshotGroupResourceStatus": { "id": "InstantSnapshotGroupResourceStatus", "properties": { @@ -71300,10 +72162,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -71395,14 +72259,16 @@ "type": "object" }, "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.", + "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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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" + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" ], "enumDescriptions": [ "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." ], "type": "string" }, @@ -71462,10 +72328,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -72544,8 +73412,7 @@ "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])?", + "description": "Name of the resource. Provided by the client when the resource is created. Must be set on either the template_attachment or on each specific attachment. If set, 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.", "type": "string" }, "pairingKey": { @@ -72868,7 +73735,7 @@ "CONNECTION_UP", "DEFUNCT", "IPSEC_CONFIGURATION_NEEDED_STATUS", - "IPSET_READY_TO_RESUME_FLOW_STATUS", + "IPSEC_READY_TO_RESUME_FLOW_STATUS", "IPV4_DOWN_IPV6_UP", "IPV4_UP_IPV6_DOWN", "PARTNER_REQUEST_RECEIVED", @@ -73828,25 +74695,21 @@ "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.", + "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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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" + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" ], "enumDescriptions": [ "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." ], "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])?", + "description": "Name of the Interconnects to be created. This must be specified on the template and/or on each individual interconnect. The name, if not empty, must be 1-63 characters long, and comply with RFC1035. Specifically, any nonempty 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.", "type": "string" }, "nocContactEmail": { @@ -73862,10 +74725,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -74311,10 +75176,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -74322,15 +75189,17 @@ "type": "array" }, "availableLinkTypes": { - "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR ", + "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 ", "items": { "enum": [ "LINK_TYPE_ETHERNET_100G_LR", - "LINK_TYPE_ETHERNET_10G_LR" + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" ], "enumDescriptions": [ "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." ], "type": "string" }, @@ -74623,6 +75492,10 @@ "format": "int64", "type": "string" }, + "l2ForwardingEnabled": { + "description": "Identifies whether L2 Interconnect Attachments can be created in this region for interconnects that are in this location.", + "type": "boolean" + }, "locationPresence": { "description": "Identifies the network presence of this location.", "enum": [ @@ -75406,6 +76279,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": { @@ -76174,6 +77054,171 @@ }, "type": "object" }, + "ListSnapshotGroups": { + "description": "Contains a list of SnapshotGroup resources.", + "id": "ListSnapshotGroups", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of SnapshotGroup resources.", + "items": { + "$ref": "SnapshotGroup" + }, + "type": "array" + }, + "kind": { + "default": "compute#snapshotGroupsList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "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" + }, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -76310,6 +77355,18 @@ "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.", "type": "string" }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this machine image. These can be later modified by the setLabels method.", + "type": "object" + }, "machineImageEncryptionKey": { "$ref": "CustomerEncryptionKey", "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later." @@ -77261,6 +78318,10 @@ "$ref": "ManagedInstancePropertiesFromFlexibilityPolicy", "description": "[Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy." }, + "scheduling": { + "$ref": "ManagedInstanceScheduling", + "description": "[Output Only] Information about the termination timestamp of the instance, if applicable." + }, "sizeInUnit": { "description": "[Output only] The size of the VM represented by this Managed Instance. This is how much this Managed Instance contributes to the size of the group.", "format": "float", @@ -77361,7 +78422,7 @@ "STANDARD" ], "enumDescriptions": [ - "Instance is provisioned with DWS Flex Start and have limited max run duration.", + "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." @@ -77482,7 +78543,7 @@ "STANDARD" ], "enumDescriptions": [ - "Instance is provisioned with DWS Flex Start and have limited max run duration.", + "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." @@ -77492,6 +78553,17 @@ }, "type": "object" }, + "ManagedInstanceScheduling": { + "id": "ManagedInstanceScheduling", + "properties": { + "terminationTimestamp": { + "description": "[Output Only] The timestamp at which the managed instance will be terminated. This is in RFC3339 text format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ManagedInstanceVersion": { "id": "ManagedInstanceVersion", "properties": { @@ -77910,6 +78982,11 @@ "type": "string" }, "type": "array" + }, + "membersCount": { + "description": "[Output Only] The number of instance group manager members in this multi-MIG.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -78295,6 +79372,10 @@ "description": "A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} - projects/{project_id}/global/networkProfiles/{network_profile_name} ", "type": "string" }, + "params": { + "$ref": "NetworkParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "peerings": { "description": "[Output Only] A list of network peerings for the resource.", "items": { @@ -80770,6 +81851,20 @@ }, "type": "object" }, + "NetworkParams": { + "description": "Additional network parameters.", + "id": "NetworkParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "NetworkPeering": { "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", "id": "NetworkPeering", @@ -80782,6 +81877,10 @@ "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", "type": "boolean" }, + "connectionStatus": { + "$ref": "NetworkPeeringConnectionStatus", + "description": "[Output Only] The effective state of the peering connection as a whole." + }, "exchangeSubnetRoutes": { "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", "type": "boolean" @@ -80811,7 +81910,7 @@ "type": "string" }, "peerMtu": { - "description": "Maximum Transmission Unit in bytes.", + "description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", "format": "int32", "type": "integer" }, @@ -80842,6 +81941,122 @@ "stateDetails": { "description": "[Output Only] Details about the current state of the peering.", "type": "string" + }, + "updateStrategy": { + "description": "The update strategy determines the semantics for updates and deletes to the peering connection configuration.", + "enum": [ + "CONSENSUS", + "INDEPENDENT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", + "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", + "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatus": { + "description": "[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.", + "id": "NetworkPeeringConnectionStatus", + "properties": { + "consensusState": { + "$ref": "NetworkPeeringConnectionStatusConsensusState", + "description": "The consensus state contains information about the status of update and delete for a consensus peering connection." + }, + "trafficConfiguration": { + "$ref": "NetworkPeeringConnectionStatusTrafficConfiguration", + "description": "The active connectivity settings for the peering connection based on the settings of the network peerings." + }, + "updateStrategy": { + "description": "The update strategy determines the update/delete semantics for this peering connection.", + "enum": [ + "CONSENSUS", + "INDEPENDENT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", + "In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", + "Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatusConsensusState": { + "description": "The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS.", + "id": "NetworkPeeringConnectionStatusConsensusState", + "properties": { + "deleteStatus": { + "description": "The status of the delete request.", + "enum": [ + "DELETE_ACKNOWLEDGED", + "DELETE_STATUS_UNSPECIFIED", + "LOCAL_DELETE_REQUESTED", + "PEER_DELETE_REQUESTED" + ], + "enumDescriptions": [ + "Both network admins have agreed this consensus peering connection can be deleted.", + "", + "Network admin has requested deletion of this peering connection.", + "The peer network admin has requested deletion of this peering connection." + ], + "type": "string" + }, + "updateStatus": { + "description": "The status of the update request.", + "enum": [ + "IN_SYNC", + "PENDING_LOCAL_ACKNOWLEDMENT", + "PENDING_PEER_ACKNOWLEDGEMENT", + "UPDATE_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "No pending configuration update proposals to the peering connection.", + "The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.", + "The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPeeringConnectionStatusTrafficConfiguration": { + "id": "NetworkPeeringConnectionStatusTrafficConfiguration", + "properties": { + "exportCustomRoutesToPeer": { + "description": "Whether custom routes are being exported to the peer network.", + "type": "boolean" + }, + "exportSubnetRoutesWithPublicIpToPeer": { + "description": "Whether subnet routes with public IP ranges are being exported to the peer network.", + "type": "boolean" + }, + "importCustomRoutesFromPeer": { + "description": "Whether custom routes are being imported from the peer network.", + "type": "boolean" + }, + "importSubnetRoutesWithPublicIpFromPeer": { + "description": "Whether subnet routes with public IP ranges are being imported from the peer network.", + "type": "boolean" + }, + "stackType": { + "description": "Which IP version(s) of traffic and routes are being imported or exported between peer networks.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", + "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." + ], + "type": "string" } }, "type": "object" @@ -81032,6 +82247,18 @@ ], "type": "string" }, + "allowDefaultNicAttachment": { + "description": "Specifies whether default NIC attachment is allowed.", + "enum": [ + "DEFAULT_NIC_ATTACHMENT_ALLOWED", + "DEFAULT_NIC_ATTACHMENT_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowExternalIpAccess": { "description": "Specifies whether VMs are allowed to have external IP access on network interfaces connected to this VPC.", "enum": [ @@ -81056,6 +82283,18 @@ ], "type": "string" }, + "allowIpForwarding": { + "description": "Specifies whether IP forwarding is allowed.", + "enum": [ + "IP_FORWARDING_ALLOWED", + "IP_FORWARDING_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowLoadBalancing": { "description": "Specifies whether cloud load balancing is allowed.", "enum": [ @@ -81080,6 +82319,30 @@ ], "type": "string" }, + "allowNcc": { + "description": "Specifies whether NCC is allowed.", + "enum": [ + "NCC_ALLOWED", + "NCC_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "allowNetworkMigration": { + "description": "Specifies whether VM network migration is allowed.", + "enum": [ + "NETWORK_MIGRATION_ALLOWED", + "NETWORK_MIGRATION_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowPacketMirroring": { "description": "Specifies whether Packet Mirroring 1.0 is supported.", "enum": [ @@ -81231,6 +82494,56 @@ }, "type": "array" }, + "subnetworkPurposes": { + "description": "Specifies which subnetwork purposes are supported.", + "items": { + "enum": [ + "AGGREGATE", + "CLOUD_EXTENSION", + "CUSTOM_HARDWARE_LINK", + "GLOBAL_MANAGED_PROXY", + "INTERNAL_HTTPS_LOAD_BALANCER", + "PEER_MIGRATION", + "PRIVATE", + "PRIVATE_NAT", + "PRIVATE_RFC_1918", + "PRIVATE_SERVICE_CONNECT", + "REGIONAL_MANAGED_PROXY" + ], + "enumDescriptions": [ + "Subnetwork used to aggregate multiple private subnetworks.", + "Subnetworks created for Cloud Extension Machines.", + "Subnetwork used for Custom Hardware Link.", + "Subnet reserved for Global Envoy-based Load Balancing.", + "Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.", + "Subnetwork will be used for Migration from one peered VPC to another. (a transient state of subnetwork while migrating resources from one project to another).", + "Regular user created or automatically created subnet.", + "Subnetwork used as source range for Private NAT Gateways.", + "Regular user created or automatically created subnet.", + "Subnetworks created for Private Service Connect in the producer network.", + "Subnetwork used for Regional Envoy-based Load Balancing." + ], + "type": "string" + }, + "type": "array" + }, + "subnetworkStackTypes": { + "description": "Specifies which subnetwork stack types are supported.", + "items": { + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY", + "IPV6_ONLY" + ], + "enumDescriptions": [ + "New VMs in this subnet can have both IPv4 and IPv6 addresses.", + "New VMs in this subnet will only be assigned IPv4 addresses.", + "New VMs in this subnet will only be assigned IPv6 addresses." + ], + "type": "string" + }, + "type": "array" + }, "unicast": { "description": "Specifies which type of unicast is supported.", "enum": [ @@ -81619,6 +82932,16 @@ }, "type": "object" }, + "NetworksRequestRemovePeeringRequest": { + "id": "NetworksRequestRemovePeeringRequest", + "properties": { + "name": { + "description": "Name of the peering, which should conform to RFC1035.", + "type": "string" + } + }, + "type": "object" + }, "NetworksUpdatePeeringRequest": { "id": "NetworksUpdatePeeringRequest", "properties": { @@ -86125,6 +87448,346 @@ }, "type": "object" }, + "PreviewFeature": { + "description": "Represents a single Google Compute Engine preview feature.", + "id": "PreviewFeature", + "properties": { + "activationStatus": { + "description": "Specifies whether the feature is enabled or disabled.", + "enum": [ + "ACTIVATION_STATE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "[Output Only] Description of the feature.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#previewFeature", + "description": "[Output only] The type of the feature. Always \"compute#previewFeature\" for preview features.", + "type": "string" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + }, + "rolloutOperation": { + "$ref": "PreviewFeatureRolloutOperation", + "description": "Rollout operation of the feature." + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "status": { + "$ref": "PreviewFeatureStatus", + "description": "[Output only] Status of the feature." + } + }, + "type": "object" + }, + "PreviewFeatureList": { + "id": "PreviewFeatureList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of PreviewFeature resources.", + "items": { + "$ref": "PreviewFeature" + }, + "type": "array" + }, + "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" + }, + "PreviewFeatureRolloutOperation": { + "description": "Represents the rollout operation", + "id": "PreviewFeatureRolloutOperation", + "properties": { + "rolloutInput": { + "$ref": "PreviewFeatureRolloutOperationRolloutInput" + }, + "rolloutStatus": { + "$ref": "PreviewFeatureRolloutOperationRolloutStatus", + "readOnly": true + } + }, + "type": "object" + }, + "PreviewFeatureRolloutOperationRolloutInput": { + "id": "PreviewFeatureRolloutOperationRolloutInput", + "properties": { + "name": { + "description": "The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.", + "type": "string" + }, + "predefinedRolloutPlan": { + "description": "Predefined rollout plan.", + "enum": [ + "ROLLOUT_PLAN_FAST_ROLLOUT", + "ROLLOUT_PLAN_TWO_DAY_ROLLOUT", + "ROLLOUT_PLAN_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "retryUuid": { + "description": "The UUID of the retry action. Only needed if this is a retry for an existing rollout. This can be used after the user canceled a rollout and want to retry it with no changes.", + "type": "string" + } + }, + "type": "object" + }, + "PreviewFeatureRolloutOperationRolloutStatus": { + "id": "PreviewFeatureRolloutOperationRolloutStatus", + "properties": { + "ongoingRollouts": { + "description": "Output only. The ongoing rollout resources. There can be multiple ongoing rollouts for a resource.", + "items": { + "$ref": "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata" + }, + "readOnly": true, + "type": "array" + }, + "previousRollout": { + "$ref": "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata", + "description": "Output only. The last completed rollout resource. This field will not be populated until the first rollout is completed.", + "readOnly": true + } + }, + "type": "object" + }, + "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata": { + "id": "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata", + "properties": { + "rollout": { + "description": "The name of the rollout Ex. organizations//locations/global/rollouts/ Ex. folders//locations/global/rollouts/ Ex. projects//locations/global/rollouts/.", + "type": "string" + }, + "rolloutPlan": { + "description": "The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.", + "type": "string" + }, + "status": { + "$ref": "PreviewFeatureStatus", + "description": "The status of the rollout." + } + }, + "type": "object" + }, + "PreviewFeatureStatus": { + "description": "[Output Only] The status of the feature.", + "id": "PreviewFeatureStatus", + "properties": { + "description": { + "description": "[Output Only] The description of the feature.", + "type": "string" + }, + "helpLink": { + "description": "[Output Only] Link to the public documentation for the feature.", + "type": "string" + }, + "releaseStatus": { + "$ref": "PreviewFeatureStatusReleaseStatus" + } + }, + "type": "object" + }, + "PreviewFeatureStatusReleaseStatus": { + "id": "PreviewFeatureStatusReleaseStatus", + "properties": { + "stage": { + "description": "[Output Only] The stage of the feature.", + "enum": [ + "DEPRECATED", + "GA", + "INTERNAL", + "PREVIEW", + "STAGE_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "Exclude until there's product requirements.", + "", + "" + ], + "type": "string" + }, + "updateDate": { + "$ref": "Date", + "description": "Output only. The last date when a feature transitioned between ReleaseStatuses.", + "readOnly": true + } + }, + "type": "object" + }, "Principal": { "description": "[Deprecated] All fields defined in a principal are ANDed.", "id": "Principal", @@ -86862,7 +88525,7 @@ "type": "string" }, "status": { - "description": "[Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. ", + "description": "[Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is announced and ready to use. - `DELETING` The public delegated prefix is being deprovsioned. ", "enum": [ "ANNOUNCED", "ANNOUNCED_TO_GOOGLE", @@ -86872,7 +88535,7 @@ "READY_TO_ANNOUNCE" ], "enumDescriptions": [ - "The public delegated prefix is active.", + "The public delegated prefix is announced and ready to use.", "The prefix is announced within Google network.", "The prefix is announced to Internet and within Google.", "The public delegated prefix is being deprovsioned.", @@ -90341,178 +92004,383 @@ }, "type": "object" }, - "RegionNetworkEndpointGroupsAttachEndpointsRequest": { - "id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be attached.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionNetworkEndpointGroupsDetachEndpointsRequest": { - "id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", - "properties": { - "networkEndpoints": { - "description": "The list of network endpoints to be detached.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { - "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", - "properties": { - "firewallPolicys": { - "description": "[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.", - "items": { - "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" - }, - "type": "array" - }, - "firewalls": { - "description": "Effective firewalls on the network.", - "items": { - "$ref": "Firewall" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { - "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", - "properties": { - "displayName": { - "description": "[Output Only] The display name of the firewall policy.", - "type": "string" - }, - "name": { - "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": { - "$ref": "FirewallPolicyRule" - }, - "type": "array" - }, - "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", - "enum": [ - "HIERARCHY", - "NETWORK", - "NETWORK_REGIONAL", - "SYSTEM_GLOBAL", - "SYSTEM_REGIONAL", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "RegionSetLabelsRequest": { - "id": "RegionSetLabelsRequest", - "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 must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", - "format": "byte", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The labels to set for this resource.", - "type": "object" - } - }, - "type": "object" - }, - "RegionSetPolicyRequest": { - "id": "RegionSetPolicyRequest", - "properties": { - "bindings": { - "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "etag": { - "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", - "format": "byte", - "type": "string" - }, - "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 in general a valid policy but certain services (like Projects) might reject them." - } - }, - "type": "object" - }, - "RegionTargetHttpsProxiesSetSslCertificatesRequest": { - "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", - "properties": { - "sslCertificates": { - "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "RegionUrlMapsValidateRequest": { - "id": "RegionUrlMapsValidateRequest", - "properties": { - "resource": { - "$ref": "UrlMap", - "description": "Content of the UrlMap to be validated." - } - }, - "type": "object" - }, - "RegionWaitForReplicationCatchUpRequest": { - "id": "RegionWaitForReplicationCatchUpRequest", - "properties": { - "maxWaitDuration": { - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, + "RegionNetworkEndpointGroupsAttachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be attached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionNetworkEndpointGroupsDetachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be detached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { + "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", + "properties": { + "firewallPolicys": { + "description": "[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.", + "items": { + "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" + }, + "type": "array" + }, + "firewalls": { + "description": "Effective firewalls on the network.", + "items": { + "$ref": "Firewall" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { + "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", + "properties": { + "displayName": { + "description": "[Output Only] The display name of the firewall policy.", + "type": "string" + }, + "name": { + "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": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, + "type": { + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", + "enum": [ + "HIERARCHY", + "NETWORK", + "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "RegionSetLabelsRequest": { + "id": "RegionSetLabelsRequest", + "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 must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels to set for this resource.", + "type": "object" + } + }, + "type": "object" + }, + "RegionSetPolicyRequest": { + "id": "RegionSetPolicyRequest", + "properties": { + "bindings": { + "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", + "format": "byte", + "type": "string" + }, + "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 in general a valid policy but certain services (like Projects) might reject them." + } + }, + "type": "object" + }, + "RegionTargetHttpsProxiesSetSslCertificatesRequest": { + "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", + "properties": { + "sslCertificates": { + "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionUrlMapsValidateRequest": { + "id": "RegionUrlMapsValidateRequest", + "properties": { + "resource": { + "$ref": "UrlMap", + "description": "Content of the UrlMap to be validated." + } + }, + "type": "object" + }, + "RegionWaitForReplicationCatchUpRequest": { + "id": "RegionWaitForReplicationCatchUpRequest", + "properties": { + "maxWaitDuration": { + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "ReliabilityRisk": { + "description": "Represents a ReliabilityRisk resource.", + "id": "ReliabilityRisk", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional textual description of the resource; provided when the resource is created.", + "type": "string" + }, + "details": { + "$ref": "RiskDetails", + "description": "[Output Only] Details of the reliability risk resource" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#reliabilityRisk", + "description": "[Output Only] Type of resource. Always compute#reliabilityRisk for reliability risks.", + "type": "string" + }, + "name": { + "description": "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "recommendation": { + "$ref": "RiskRecommendation", + "description": "The recommendations to mitigate the risk." + }, + "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" + }, + "ReliabilityRisksListResponse": { + "id": "ReliabilityRisksListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of ReliabilityRisk resources.", + "items": { + "$ref": "ReliabilityRisk" + }, + "type": "array" + }, + "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" + }, "ReplicationDetails": { "id": "ReplicationDetails", "properties": { @@ -90601,6 +92469,10 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "enableEmergentMaintenance": { + "description": "Indicates if this group of VMs have emergent maintenance enabled.", + "type": "boolean" + }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -90611,6 +92483,13 @@ "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", "type": "string" }, + "linkedCommitments": { + "description": "[Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.", + "items": { + "type": "string" + }, + "type": "array" + }, "name": { "annotations": { "required": [ @@ -90654,6 +92533,20 @@ "description": "[Output Only] Reserved for future use.", "type": "boolean" }, + "schedulingType": { + "description": "The type of maintenance for the reservation.", + "enum": [ + "GROUPED", + "GROUP_MAINTENANCE_TYPE_UNSPECIFIED", + "INDEPENDENT" + ], + "enumDescriptions": [ + "Maintenance on all reserved instances in the reservation is synchronized.", + "Unknown maintenance type.", + "Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." + ], + "type": "string" + }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" @@ -90945,6 +92838,16 @@ "$ref": "GroupMaintenanceInfo", "description": "[Output Only] Maintenance information for this reservation block." }, + "reservationSubBlockCount": { + "description": "[Output Only] The number of reservation subBlocks associated with this reservation block.", + "format": "int32", + "type": "integer" + }, + "reservationSubBlockInUseCount": { + "description": "[Output Only] The number of in-use reservation subBlocks associated with this reservation block. If at least one VM is running on a subBlock, it is considered in-use.", + "format": "int32", + "type": "integer" + }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" @@ -91154,35 +93057,288 @@ }, "type": "object" }, - "ReservationList": { - "id": "ReservationList", + "ReservationList": { + "id": "ReservationList", + "properties": { + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" + }, + "items": { + "description": "[Output Only] A list of Allocation resources.", + "items": { + "$ref": "Reservation" + }, + "type": "array" + }, + "kind": { + "default": "compute#reservationList", + "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "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" + }, + "ReservationSubBlock": { + "description": "Represents a reservation subBlock resource.", + "id": "ReservationSubBlock", "properties": { + "count": { + "description": "[Output Only] The number of hosts that are allocated in this reservation subBlock.", + "format": "int32", + "type": "integer" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "inUseCount": { + "description": "[Output Only] The number of instances that are currently in use on this reservation subBlock.", + "format": "int32", + "type": "integer" + }, + "kind": { + "default": "compute#reservationSubBlock", + "description": "[Output Only] Type of the resource. Always compute#reservationSubBlock for reservation subBlocks.", + "type": "string" + }, + "name": { + "description": "[Output Only] The name of this reservation subBlock generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "physicalTopology": { + "$ref": "ReservationSubBlockPhysicalTopology", + "description": "[Output Only] The physical topology of the reservation subBlock." + }, + "reservationSubBlockMaintenance": { + "$ref": "GroupMaintenanceInfo", + "description": "Maintenance information for this reservation subBlock." + }, + "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": { + "description": "[Output Only] Status of the reservation subBlock.", + "enum": [ + "CREATING", + "DELETING", + "INVALID", + "READY" + ], + "enumDescriptions": [ + "Resources are being allocated for the reservation subBlock.", + "Reservation subBlock is currently being deleted.", + "", + "Reservation subBlock has allocated all its resources." + ], + "type": "string" + }, + "zone": { + "description": "[Output Only] Zone in which the reservation subBlock resides.", + "type": "string" + } + }, + "type": "object" + }, + "ReservationSubBlockPhysicalTopology": { + "id": "ReservationSubBlockPhysicalTopology", + "properties": { + "block": { + "description": "The hash of the capacity block within the cluster.", + "type": "string" + }, + "cluster": { + "description": "The cluster name of the reservation subBlock.", + "type": "string" + }, + "subBlock": { + "description": "The hash of the capacity sub-block within the capacity block.", + "type": "string" + } + }, + "type": "object" + }, + "ReservationSubBlocksGetResponse": { + "id": "ReservationSubBlocksGetResponse", + "properties": { + "resource": { + "$ref": "ReservationSubBlock" + } + }, + "type": "object" + }, + "ReservationSubBlocksListResponse": { + "description": "A list of reservation subBlocks under a single reservation.", + "id": "ReservationSubBlocksListResponse", + "properties": { + "id": { + "description": "Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "[Output Only] A list of Allocation resources.", + "description": "A list of reservation subBlock resources.", "items": { - "$ref": "Reservation" + "$ref": "ReservationSubBlock" }, "type": "array" }, "kind": { - "default": "compute#reservationList", - "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations", + "default": "compute#reservationSubBlock", + "description": "Type of the resource. Always compute#reservationSubBlock for a list of reservation subBlocks.", "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.", + "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.", + "description": "Server-defined URL for this resource.", "type": "string" }, "warning": { - "description": "[Output Only] Informational warning message.", + "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.", @@ -92609,10 +94765,30 @@ "description": "Effective values of predefined metadata keys for an instance.", "id": "ResourceStatusEffectiveInstanceMetadata", "properties": { + "blockProjectSshKeysMetadataValue": { + "description": "Effective block-project-ssh-keys value at Instance level.", + "type": "boolean" + }, + "enableGuestAttributesMetadataValue": { + "description": "Effective enable-guest-attributes value at Instance level.", + "type": "boolean" + }, + "enableOsInventoryMetadataValue": { + "description": "Effective enable-osinventory value at Instance level.", + "type": "boolean" + }, + "enableOsconfigMetadataValue": { + "description": "Effective enable-osconfig value at Instance level.", + "type": "boolean" + }, "enableOsloginMetadataValue": { "description": "Effective enable-oslogin value at Instance level.", "type": "boolean" }, + "serialPortEnableMetadataValue": { + "description": "Effective serial-port-enable value at Instance level.", + "type": "boolean" + }, "vmDnsSettingMetadataValue": { "description": "Effective VM DNS setting at Instance level.", "type": "string" @@ -92639,6 +94815,7 @@ "SCHEDULED_STOP", "SHUTDOWN_DUE_TO_HOST_ERROR", "SHUTDOWN_DUE_TO_MAINTENANCE", + "SHUTDOWN_DUE_TO_POWER_EVENT", "USER_TERMINATED" ], "enumDescriptions": [ @@ -92655,6 +94832,7 @@ "Terminated due to scheduled stop", "Terminated due to host error", "Terminated due to maintenance", + "Terminated due to power event", "Terminated by user" ], "type": "string" @@ -92778,6 +94956,96 @@ }, "type": "object" }, + "RiskDetails": { + "description": "Details about a risk.", + "id": "RiskDetails", + "properties": { + "duration": { + "description": "The duration of the risk since it was detected.", + "format": "google-duration", + "type": "string" + }, + "globalDnsInsight": { + "$ref": "RiskDetailsGlobalDnsInsight" + }, + "lastUpdateTimestamp": { + "description": "The last time the risk was updated.", + "format": "google-datetime", + "type": "string" + }, + "severity": { + "description": "The severity of the risk.", + "enum": [ + "CRITICAL", + "HIGH", + "LOW", + "MEDIUM", + "SEVERITY_UNSPECIFIED" + ], + "enumDescriptions": [ + "Critical severity.", + "High severity.", + "Low severity.", + "Medium severity.", + "No severity specified. The default value." + ], + "type": "string" + }, + "type": { + "description": "The type of risk.", + "enum": [ + "GLOBAL_DNS", + "RISK_TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "Risk type related to global DNS.", + "Default value. This value is unused." + ], + "type": "string" + } + }, + "type": "object" + }, + "RiskDetailsGlobalDnsInsight": { + "id": "RiskDetailsGlobalDnsInsight", + "properties": { + "projectDefaultIsGlobalDns": { + "description": "Whether the project default DNS setting is global or not.", + "type": "boolean" + }, + "queryObservationWindow": { + "description": "The observation window for the query counts.", + "format": "google-duration", + "type": "string" + }, + "riskyQueryCount": { + "description": "The number of queries that are risky. This will always be less than total_query_count.", + "format": "int64", + "type": "string" + }, + "totalQueryCount": { + "description": "The total number of queries in the observation window.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RiskRecommendation": { + "description": "Recommendation with reference url.", + "id": "RiskRecommendation", + "properties": { + "content": { + "description": "Mitigation guide for the risk.", + "type": "string" + }, + "referenceUrl": { + "description": "URL referencing a more detailed mitigation guide.", + "type": "string" + } + }, + "type": "object" + }, "RolloutPolicy": { "description": "A rollout policy configuration.", "id": "RolloutPolicy", @@ -92891,7 +95159,7 @@ "type": "integer" }, "nextHopInterconnectAttachment": { - "description": "[Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.", + "description": "[Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.", "type": "string" }, "nextHopIp": { @@ -92929,6 +95197,10 @@ "description": "The URL to a VpnTunnel that should handle matching packets.", "type": "string" }, + "params": { + "$ref": "RouteParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "priority": { "annotations": { "required": [ @@ -93306,6 +95578,20 @@ }, "type": "object" }, + "RouteParams": { + "description": "Additional route parameters.", + "id": "RouteParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "RoutePolicy": { "id": "RoutePolicy", "properties": { @@ -95778,7 +98064,7 @@ "STANDARD" ], "enumDescriptions": [ - "Instance is provisioned with DWS Flex Start and have limited max run duration.", + "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." @@ -95787,7 +98073,8 @@ }, "shutdownTimeout": { "$ref": "Duration", - "description": "Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs." + "deprecated": true, + "description": "DEPRECATED: please use skipGuestOsShutdown. Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs." }, "terminationTime": { "description": "Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.", @@ -95799,6 +98086,7 @@ "AUTO", "BALANCED", "COST_OPTIMIZED", + "MANAGED", "OFF", "PERFORMANCE", "UNSPECIFIED" @@ -95807,6 +98095,7 @@ "\"Automatically maximize savings and minimize performance impact by matching license optimization mode to current CPU utilization.", "Significant license cost savings via moderate throttles (40% baseline, 10 minute maximum burst at full utilization).", "Maximum license cost savings via restrictive throttles (20% baseline, 3.75 minute maximum burst at full utilization).", + "License optimization mode managed by Google, in exchange for guaranteed discounts. This mode cannot be set by users, only by Google internal tooling.", "No license cost savings with maximum CPU performance.", "Moderate license cost savings via least restrictive throttles (60% baseline, 22.5 minute maximum burst at full utilization).", "Unspecified license optimization mode defaults to `OFF`." @@ -96530,7 +98819,7 @@ "type": "string" }, "requestBodyInspectionSize": { - "description": "The maximum request size chosen by the customer with Waf enabled. Currently only \"8KB\" and \"128KB\" are supported. Values are case insensitive.", + "description": "The maximum request size chosen by the customer with Waf enabled. Values supported are \"8KB\", \"16KB, \"32KB\", \"48KB\" and \"64KB\". Values are case insensitive.", "type": "string" }, "userIpRequestHeaders": { @@ -97936,6 +100225,13 @@ "description": "The url of a connected endpoint.", "type": "string" }, + "natIps": { + "description": "NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it.", + "items": { + "type": "string" + }, + "type": "array" + }, "propagatedConnectionCount": { "description": "The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to.", "format": "uint32", @@ -98603,7 +100899,7 @@ "type": "object" }, "Snapshot": { - "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", + "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", "id": "Snapshot", "properties": { "architecture": { @@ -98752,6 +101048,14 @@ "$ref": "CustomerEncryptionKey", "description": "Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later." }, + "snapshotGroupId": { + "description": "[Output Only] The unique ID of the snapshot group that this snapshot belongs to.", + "type": "string" + }, + "snapshotGroupName": { + "description": "[Output only] The snapshot group that this snapshot belongs to.", + "type": "string" + }, "snapshotType": { "description": "Indicates the type of the snapshot.", "enum": [ @@ -99017,6 +101321,123 @@ }, "type": "object" }, + "SnapshotGroup": { + "description": "Represents a SnapshotGroup resource. A snapshot group is a set of snapshots that represents a point in time state of a consistency group.", + "id": "SnapshotGroup", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "Optional. An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#snapshotGroup", + "description": "[Output Only] Type of the resource. Always compute#snapshotGroup for SnapshotGroup resources.", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "sourceInfo": { + "$ref": "SnapshotGroupSourceInfo", + "description": "[Output Only]" + }, + "sourceInstantSnapshotGroup": { + "description": "Input field for the source instant snapshot group.", + "type": "string" + }, + "sourceInstantSnapshotGroupInfo": { + "$ref": "SnapshotGroupSourceInstantSnapshotGroupInfo", + "description": "[Output Only]" + }, + "status": { + "description": "[Output Only]", + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "INVALID", + "READY", + "UNKNOWN", + "UPLOADING" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "SnapshotGroupParameters": { + "id": "SnapshotGroupParameters", + "properties": { + "replicaZones": { + "description": "URLs of the zones where disks should be replicated to. Only applicable for regional resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceSnapshotGroup": { + "description": "The source snapshot group used to create disks. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshotGroups/snapshotGroup - projects/project/global/snapshotGroups/snapshotGroup - global/snapshotGroups/snapshotGroup ", + "type": "string" + }, + "type": { + "description": "URL of the disk type resource describing which disk type to use to create disks. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.", + "type": "string" + } + }, + "type": "object" + }, + "SnapshotGroupSourceInfo": { + "id": "SnapshotGroupSourceInfo", + "properties": { + "consistencyGroup": { + "type": "string" + }, + "consistencyGroupId": { + "type": "string" + } + }, + "type": "object" + }, + "SnapshotGroupSourceInstantSnapshotGroupInfo": { + "id": "SnapshotGroupSourceInstantSnapshotGroupInfo", + "properties": { + "instantSnapshotGroup": { + "type": "string" + }, + "instantSnapshotGroupId": { + "type": "string" + } + }, + "type": "object" + }, "SnapshotList": { "description": "Contains a list of Snapshot resources.", "id": "SnapshotList", @@ -100942,6 +103363,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, + "format": "google.protobuf.Any", "type": "object" }, "type": "array" @@ -102440,6 +104862,7 @@ "properties": { "entries": { "additionalProperties": { + "format": "google.protobuf.Value", "type": "any" }, "description": "Map of a partner metadata that belong to the same subdomain. It accepts any value including google.protobuf.Struct.", @@ -102590,6 +105013,10 @@ "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.", "type": "string" }, + "params": { + "$ref": "SubnetworkParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "privateIpGoogleAccess": { "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.", "type": "boolean" @@ -102609,7 +105036,6 @@ "type": "string" }, "purpose": { - "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", @@ -102699,6 +105125,27 @@ ], "type": "string" }, + "systemReservedExternalIpv6Ranges": { + "description": "Output only. [Output Only] The array of external IPv6 network ranges reserved from the subnetwork's external IPv6 range for system use.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "systemReservedInternalIpv6Ranges": { + "description": "Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "utilizationDetails": { + "$ref": "SubnetworkUtilizationDetails", + "description": "Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.", + "readOnly": true + }, "vlans": { "description": "A repeated field indicating the VLAN IDs supported on this subnetwork. During Subnet creation, specifying vlan is valid only if enable_l2 is true. During Subnet Update, specifying vlan is allowed only for l2 enabled subnets. Restricted to only one VLAN.", "items": { @@ -103088,6 +105535,20 @@ }, "type": "object" }, + "SubnetworkParams": { + "description": "Additional subnetwork parameters.", + "id": "SubnetworkParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "SubnetworkSecondaryRange": { "description": "Represents a secondary IP range of a subnetwork.", "id": "SubnetworkSecondaryRange", @@ -103107,6 +105568,64 @@ }, "type": "object" }, + "SubnetworkUtilizationDetails": { + "description": "The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.", + "id": "SubnetworkUtilizationDetails", + "properties": { + "externalIpv6InstanceUtilization": { + "$ref": "SubnetworkUtilizationDetailsIPV6Utilization", + "description": "Utilizations of external IPV6 IP range." + }, + "externalIpv6LbUtilization": { + "$ref": "SubnetworkUtilizationDetailsIPV6Utilization", + "description": "Utilizations of external IPV6 IP range for NetLB." + }, + "internalIpv6Utilization": { + "$ref": "SubnetworkUtilizationDetailsIPV6Utilization", + "description": "Utilizations of internal IPV6 IP range." + }, + "ipv4Utilizations": { + "description": "Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.", + "items": { + "$ref": "SubnetworkUtilizationDetailsIPV4Utilization" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubnetworkUtilizationDetailsIPV4Utilization": { + "description": "The IPV4 utilization of a single IP range.", + "id": "SubnetworkUtilizationDetailsIPV4Utilization", + "properties": { + "rangeName": { + "description": "Will be set for secondary range. Empty for primary IPv4 range.", + "type": "string" + }, + "totalAllocatedIp": { + "format": "int64", + "type": "string" + }, + "totalFreeIp": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "SubnetworkUtilizationDetailsIPV6Utilization": { + "description": "The IPV6 utilization of a single IP range.", + "id": "SubnetworkUtilizationDetailsIPV6Utilization", + "properties": { + "totalAllocatedIp": { + "$ref": "Uint128" + }, + "totalFreeIp": { + "$ref": "Uint128" + } + }, + "type": "object" + }, "SubnetworksExpandIpCidrRangeRequest": { "id": "SubnetworksExpandIpCidrRangeRequest", "properties": { @@ -107565,6 +110084,31 @@ "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.", "type": "string" }, + "maintenanceOnShutdown": { + "description": "Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.", + "type": "boolean" + }, + "maintenanceReasons": { + "description": "The reasons for the maintenance. Only valid for vms.", + "items": { + "enum": [ + "FAILURE_GPU_TEMPERATURE", + "FAILURE_GPU_XID", + "FAILURE_NVLINK", + "INFRASTRUCTURE_RELOCATION", + "MAINTENANCE_REASON_UNKNOWN" + ], + "enumDescriptions": [ + "Maintenance due to high GPU temperature.", + "Maintenance due to GPU xid failure.", + "Maintenance due to NVLink failure.", + "Maintenance due to infrastructure relocation.", + "Unknown maintenance reason. Do not use this value." + ], + "type": "string" + }, + "type": "array" + }, "maintenanceStatus": { "enum": [ "ONGOING", @@ -108349,7 +110893,6 @@ "type": "string" }, "purpose": { - "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", diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index f2b1f559588..2307b7d313a 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -16472,6 +16472,43 @@ "https://www.googleapis.com/auth/compute" ] }, + "setLabels": { + "description": "Sets the labels on a machine image. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/global/machineImages/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.machineImages.setLabels", + "parameterOrder": [ + "project", + "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" + } + }, + "path": "projects/{project}/global/machineImages/{resource}/setLabels", + "request": { + "$ref": "GlobalSetLabelsRequest" + }, + "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}/global/machineImages/{resource}/testIamPermissions", @@ -29093,6 +29130,12 @@ "firewallPolicy" ], "parameters": { + "associatedPolicyToBeReplaced": { + "description": "Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'.", + "location": "query", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "type": "string" + }, "firewallPolicy": { "description": "Name of the firewall policy to update.", "location": "path", @@ -29684,6 +29727,56 @@ "https://www.googleapis.com/auth/compute" ] }, + "patchAssociation": { + "description": "Updates an association for the specified network firewall policy.", + "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchAssociation", + "httpMethod": "POST", + "id": "compute.regionNetworkFirewallPolicies.patchAssociation", + "parameterOrder": [ + "project", + "region", + "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" + }, + "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}/firewallPolicies/{firewallPolicy}/patchAssociation", + "request": { + "$ref": "FirewallPolicyAssociation" + }, + "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}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule", @@ -33649,14 +33742,12 @@ "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" }, @@ -43877,7 +43968,6 @@ "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" }, @@ -43896,7 +43986,6 @@ "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" } @@ -43923,7 +44012,6 @@ "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" }, @@ -43937,7 +44025,6 @@ "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" } @@ -43964,7 +44051,6 @@ "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" }, @@ -44010,7 +44096,6 @@ "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" }, @@ -44073,7 +44158,6 @@ "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" }, @@ -44103,7 +44187,6 @@ "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" } @@ -44409,7 +44492,7 @@ } } }, - "revision": "20250302", + "revision": "20250415", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -47130,7 +47213,7 @@ "type": "boolean" }, "group": { - "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.", + "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP.", "type": "string" }, "maxConnections": { @@ -47308,7 +47391,7 @@ "type": "integer" }, "defaultTtl": { - "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "format": "int32", "type": "integer" }, @@ -47333,7 +47416,7 @@ "type": "boolean" }, "serveWhileStale": { - "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", + "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "format": "int32", "type": "integer" }, @@ -47776,11 +47859,12 @@ "type": "string" }, "connectionDraining": { - "$ref": "ConnectionDraining" + "$ref": "ConnectionDraining", + "description": "connectionDraining cannot be specified with haPolicy." }, "connectionTrackingPolicy": { "$ref": "BackendServiceConnectionTrackingPolicy", - "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers." + "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy." }, "consistentHash": { "$ref": "ConsistentHashLoadBalancerSettings", @@ -47848,15 +47932,19 @@ }, "failoverPolicy": { "$ref": "BackendServiceFailoverPolicy", - "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview)." + "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy." }, "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.", "format": "byte", "type": "string" }, + "haPolicy": { + "$ref": "BackendServiceHAPolicy", + "description": "Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers." + }, "healthChecks": { - "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.", + "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.", "items": { "type": "string" }, @@ -47920,7 +48008,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -47966,12 +48054,12 @@ "type": "string" }, "network": { - "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.", + "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. 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." + "description": "Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy." }, "outlierDetection": { "$ref": "OutlierDetection", @@ -48041,7 +48129,7 @@ "type": "string" }, "sessionAffinity": { - "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).", + "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy.", "enum": [ "CLIENT_IP", "CLIENT_IP_NO_DESTINATION", @@ -48071,7 +48159,8 @@ "description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY." }, "subsetting": { - "$ref": "Subsetting" + "$ref": "Subsetting", + "description": "subsetting cannot be specified with haPolicy." }, "timeoutSec": { "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.", @@ -48292,7 +48381,7 @@ "type": "integer" }, "defaultTtl": { - "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "format": "int32", "type": "integer" }, @@ -48317,7 +48406,7 @@ "type": "boolean" }, "serveWhileStale": { - "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", + "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "format": "int32", "type": "integer" }, @@ -48490,6 +48579,24 @@ }, "type": "object" }, + "BackendServiceHAPolicy": { + "id": "BackendServiceHAPolicy", + "properties": { + "fastIPMove": { + "description": "Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to update the leader. - >GARP_RA: Provides a method to very quickly define a new network endpoint as the leader. This method is faster than updating the leader using the haPolicy.leader API. Fast IP move works as follows: The VM hosting the network endpoint that should become the new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays active for approximately 20 minutes. After triggering fast failover, you must also appropriately set the haPolicy.leader. - The new leader instance should continue to send GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from different VM instances at the same time. If multiple instances continue to send GARP/RA packets, traffic might be routed to different destinations in an alternating order. This condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always takes priority over the leader API. Using the haPolicy.leader API to change the leader to a different instance will have no effect until the GARP/RA request becomes inactive. - The GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding rules refer to a regional backend service, you need only send a GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend service will also be moved to the sender of the GARP or RA packet. The following are the Fast IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED.", + "enum": [ + "DISABLED", + "GARP_RA" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "BackendServiceHttpCookie": { "description": "The HTTP cookie used for stateful session affinity.", "id": "BackendServiceHttpCookie", @@ -49657,7 +49764,7 @@ "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.", + "description": "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" }, @@ -49945,6 +50052,7 @@ "ACCELERATOR_OPTIMIZED_A3", "ACCELERATOR_OPTIMIZED_A3_MEGA", "ACCELERATOR_OPTIMIZED_A3_ULTRA", + "ACCELERATOR_OPTIMIZED_A4", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", @@ -49994,6 +50102,7 @@ "", "", "", + "", "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" @@ -50629,10 +50738,6 @@ "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" @@ -53153,6 +53258,10 @@ "description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default ", "type": "string" }, + "params": { + "$ref": "FirewallParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "priority": { "description": "Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.", "format": "int32", @@ -53378,6 +53487,20 @@ }, "type": "object" }, + "FirewallParams": { + "description": "Additional firewall parameters.", + "id": "FirewallParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "FirewallPoliciesListAssociationsResponse": { "id": "FirewallPoliciesListAssociationsResponse", "properties": { @@ -53640,6 +53763,11 @@ "description": "The name for an association.", "type": "string" }, + "priority": { + "description": "An integer indicating the priority of an association. The priority must be a positive value between 1 and 2147483647. Firewall Policies are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority. The default value is `1000`. If two associations have the same priority then lexicographical order on association names is applied.", + "format": "int32", + "type": "integer" + }, "shortName": { "description": "[Output Only] The short name of the firewall policy of the association.", "type": "string" @@ -56011,6 +56139,35 @@ }, "type": "object" }, + "GRPCTLSHealthCheck": { + "id": "GRPCTLSHealthCheck", + "properties": { + "grpcServiceName": { + "description": "The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.", + "type": "string" + }, + "port": { + "description": "The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.", + "format": "int32", + "type": "integer" + }, + "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" + } + }, + "type": "object" + }, "GlobalAddressesMoveRequest": { "id": "GlobalAddressesMoveRequest", "properties": { @@ -56217,7 +56374,7 @@ "id": "GuestOsFeature", "properties": { "type": { - "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", + "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features.", "enum": [ "FEATURE_TYPE_UNSPECIFIED", "GVNIC", @@ -56432,6 +56589,9 @@ "grpcHealthCheck": { "$ref": "GRPCHealthCheck" }, + "grpcTlsHealthCheck": { + "$ref": "GRPCTLSHealthCheck" + }, "healthyThreshold": { "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", "format": "int32", @@ -56495,6 +56655,7 @@ "description": "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.", "enum": [ "GRPC", + "GRPC_WITH_TLS", "HTTP", "HTTP2", "HTTPS", @@ -56509,6 +56670,7 @@ "", "", "", + "", "" ], "type": "string" @@ -60104,7 +60266,7 @@ "id": "InstanceGroupManagerInstanceLifecyclePolicy", "properties": { "defaultActionOnFailure": { - "description": "The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. ", + "description": "The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM.", "enum": [ "DELETE", "DO_NOTHING", @@ -60112,8 +60274,8 @@ ], "enumDescriptions": [ "MIG deletes a failed or an unhealthy VM. Deleting the VM decreases the target size of the MIG.", - "MIG does not repair a failed or an unhealthy VM.", - "(Default) MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG." + "MIG does not repair a failed VM.", + "(default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG." ], "type": "string" }, @@ -60338,6 +60500,13 @@ "format": "uint64", "type": "string" }, + "instances": { + "description": "The names of instances to be created by this resize request. The number of names specified determines the number of instances to create. The group's target size will be increased by this number. This field cannot be used together with 'resize_by'.", + "items": { + "$ref": "PerInstanceConfig" + }, + "type": "array" + }, "kind": { "default": "compute#instanceGroupManagerResizeRequest", "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.", @@ -63183,7 +63352,7 @@ "id": "InstancesReportHostAsFaultyRequest", "properties": { "disruptionSchedule": { - "description": "The disruption schedule for the VM. Default to IMMEDIATE.", + "description": "The disruption schedule for the VM. Required field, only allows IMMEDIATE.", "enum": [ "DISRUPTION_SCHEDULE_UNSPECIFIED", "FUTURE", @@ -64201,14 +64370,16 @@ "type": "object" }, "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.", + "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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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" + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" ], "enumDescriptions": [ "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." ], "type": "string" }, @@ -65579,15 +65750,17 @@ "type": "array" }, "availableLinkTypes": { - "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR ", + "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 ", "items": { "enum": [ "LINK_TYPE_ETHERNET_100G_LR", - "LINK_TYPE_ETHERNET_10G_LR" + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" ], "enumDescriptions": [ "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." ], "type": "string" }, @@ -66855,6 +67028,18 @@ "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.", "type": "string" }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this machine image. These can be later modified by the setLabels method.", + "type": "object" + }, "machineImageEncryptionKey": { "$ref": "CustomerEncryptionKey", "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later." @@ -68383,6 +68568,10 @@ "description": "A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} - projects/{project_id}/global/networkProfiles/{network_profile_name} ", "type": "string" }, + "params": { + "$ref": "NetworkParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "peerings": { "description": "[Output Only] A list of network peerings for the resource.", "items": { @@ -70789,6 +70978,20 @@ }, "type": "object" }, + "NetworkParams": { + "description": "Additional network parameters.", + "id": "NetworkParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "NetworkPeering": { "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", "id": "NetworkPeering", @@ -70826,7 +71029,7 @@ "type": "string" }, "peerMtu": { - "description": "Maximum Transmission Unit in bytes.", + "description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", "format": "int32", "type": "integer" }, @@ -71034,6 +71237,18 @@ ], "type": "string" }, + "allowDefaultNicAttachment": { + "description": "Specifies whether default NIC attachment is allowed.", + "enum": [ + "DEFAULT_NIC_ATTACHMENT_ALLOWED", + "DEFAULT_NIC_ATTACHMENT_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowExternalIpAccess": { "description": "Specifies whether VMs are allowed to have external IP access on network interfaces connected to this VPC.", "enum": [ @@ -71058,6 +71273,18 @@ ], "type": "string" }, + "allowIpForwarding": { + "description": "Specifies whether IP forwarding is allowed.", + "enum": [ + "IP_FORWARDING_ALLOWED", + "IP_FORWARDING_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowLoadBalancing": { "description": "Specifies whether cloud load balancing is allowed.", "enum": [ @@ -71082,6 +71309,30 @@ ], "type": "string" }, + "allowNcc": { + "description": "Specifies whether NCC is allowed.", + "enum": [ + "NCC_ALLOWED", + "NCC_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "allowNetworkMigration": { + "description": "Specifies whether VM network migration is allowed.", + "enum": [ + "NETWORK_MIGRATION_ALLOWED", + "NETWORK_MIGRATION_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowPacketMirroring": { "description": "Specifies whether Packet Mirroring 1.0 is supported.", "enum": [ @@ -71233,6 +71484,50 @@ }, "type": "array" }, + "subnetworkPurposes": { + "description": "Specifies which subnetwork purposes are supported.", + "items": { + "enum": [ + "GLOBAL_MANAGED_PROXY", + "INTERNAL_HTTPS_LOAD_BALANCER", + "PEER_MIGRATION", + "PRIVATE", + "PRIVATE_NAT", + "PRIVATE_RFC_1918", + "PRIVATE_SERVICE_CONNECT", + "REGIONAL_MANAGED_PROXY" + ], + "enumDescriptions": [ + "Subnet reserved for Global Envoy-based Load Balancing.", + "Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.", + "Subnetwork will be used for Migration from one peered VPC to another. (a transient state of subnetwork while migrating resources from one project to another).", + "Regular user created or automatically created subnet.", + "Subnetwork used as source range for Private NAT Gateways.", + "Regular user created or automatically created subnet.", + "Subnetworks created for Private Service Connect in the producer network.", + "Subnetwork used for Regional Envoy-based Load Balancing." + ], + "type": "string" + }, + "type": "array" + }, + "subnetworkStackTypes": { + "description": "Specifies which subnetwork stack types are supported.", + "items": { + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY", + "IPV6_ONLY" + ], + "enumDescriptions": [ + "New VMs in this subnet can have both IPv4 and IPv6 addresses.", + "New VMs in this subnet will only be assigned IPv4 addresses.", + "New VMs in this subnet will only be assigned IPv6 addresses." + ], + "type": "string" + }, + "type": "array" + }, "unicast": { "description": "Specifies which type of unicast is supported.", "enum": [ @@ -79353,6 +79648,13 @@ "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", "type": "string" }, + "linkedCommitments": { + "description": "[Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.", + "items": { + "type": "string" + }, + "type": "array" + }, "name": { "annotations": { "required": [ @@ -81055,6 +81357,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": { @@ -81345,7 +81651,7 @@ "type": "integer" }, "nextHopInterconnectAttachment": { - "description": "[Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.", + "description": "[Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.", "type": "string" }, "nextHopIp": { @@ -81383,6 +81689,10 @@ "description": "The URL to a VpnTunnel that should handle matching packets.", "type": "string" }, + "params": { + "$ref": "RouteParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "priority": { "annotations": { "required": [ @@ -81756,6 +82066,20 @@ }, "type": "object" }, + "RouteParams": { + "description": "Additional route parameters.", + "id": "RouteParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "RoutePolicy": { "id": "RoutePolicy", "properties": { @@ -86581,7 +86905,7 @@ "type": "object" }, "Snapshot": { - "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", + "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", "id": "Snapshot", "properties": { "architecture": { @@ -90436,6 +90760,10 @@ "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.", "type": "string" }, + "params": { + "$ref": "SubnetworkParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "privateIpGoogleAccess": { "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.", "type": "boolean" @@ -90455,7 +90783,6 @@ "type": "string" }, "purpose": { - "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", @@ -90916,6 +91243,20 @@ }, "type": "object" }, + "SubnetworkParams": { + "description": "Additional subnetwork parameters.", + "id": "SubnetworkParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "SubnetworkSecondaryRange": { "description": "Represents a secondary IP range of a subnetwork.", "id": "SubnetworkSecondaryRange", @@ -95128,6 +95469,10 @@ "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.", "type": "string" }, + "maintenanceOnShutdown": { + "description": "Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.", + "type": "boolean" + }, "maintenanceStatus": { "enum": [ "ONGOING", @@ -95882,7 +96227,6 @@ "type": "string" }, "purpose": { - "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", @@ -97805,9 +98149,6 @@ "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." diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index c2067b7eca8..ace5bec7788 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -14418,6 +14418,43 @@ "https://www.googleapis.com/auth/compute" ] }, + "setLabels": { + "description": "Sets the labels on a machine image. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/global/machineImages/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.machineImages.setLabels", + "parameterOrder": [ + "project", + "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" + } + }, + "path": "projects/{project}/global/machineImages/{resource}/setLabels", + "request": { + "$ref": "GlobalSetLabelsRequest" + }, + "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}/global/machineImages/{resource}/testIamPermissions", @@ -28903,6 +28940,179 @@ } } }, + "reservationBlocks": { + "methods": { + "get": { + "description": "Retrieves information about the specified reservation block.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", + "httpMethod": "GET", + "id": "compute.reservationBlocks.get", + "parameterOrder": [ + "project", + "zone", + "reservation", + "reservationBlock" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "required": true, + "type": "string" + }, + "reservation": { + "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "reservationBlock": { + "description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "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}", + "response": { + "$ref": "ReservationBlocksGetResponse" + }, + "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 reservation blocks under a single reservation.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "httpMethod": "GET", + "id": "compute.reservationBlocks.list", + "parameterOrder": [ + "project", + "zone", + "reservation" + ], + "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", + "required": true, + "type": "string" + }, + "reservation": { + "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "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. Zone name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", + "response": { + "$ref": "ReservationBlocksListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "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", + "required": true, + "type": "string" + }, + "reservationBlock": { + "description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "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" + ] + } + } + }, "reservations": { "methods": { "aggregatedList": { @@ -29215,6 +29425,54 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "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", + "reservation" + ], + "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" + }, + "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}/performMaintenance", + "request": { + "$ref": "ReservationsPerformMaintenanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "resize": { "description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", @@ -38642,7 +38900,7 @@ } } }, - "revision": "20250302", + "revision": "20250415", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -40047,6 +40305,15 @@ "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { + "reservationBlockCount": { + "description": "The number of reservation blocks associated with this reservation.", + "format": "int32", + "type": "integer" + }, + "reservationMaintenance": { + "$ref": "GroupMaintenanceInfo", + "description": "Maintenance information for this reservation" + }, "specificSkuAllocation": { "$ref": "AllocationResourceStatusSpecificSKUAllocation", "description": "Allocation Properties of this reservation." @@ -41288,7 +41555,7 @@ "type": "boolean" }, "group": { - "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.", + "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP.", "type": "string" }, "maxConnections": { @@ -41456,7 +41723,7 @@ "type": "integer" }, "defaultTtl": { - "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "format": "int32", "type": "integer" }, @@ -41481,7 +41748,7 @@ "type": "boolean" }, "serveWhileStale": { - "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", + "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "format": "int32", "type": "integer" }, @@ -41770,11 +42037,12 @@ "type": "string" }, "connectionDraining": { - "$ref": "ConnectionDraining" + "$ref": "ConnectionDraining", + "description": "connectionDraining cannot be specified with haPolicy." }, "connectionTrackingPolicy": { "$ref": "BackendServiceConnectionTrackingPolicy", - "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers." + "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy." }, "consistentHash": { "$ref": "ConsistentHashLoadBalancerSettings", @@ -41817,17 +42085,40 @@ "description": "If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.", "type": "boolean" }, + "externalManagedMigrationState": { + "description": "Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.", + "enum": [ + "PREPARE", + "TEST_ALL_TRAFFIC", + "TEST_BY_PERCENTAGE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "externalManagedMigrationTestingPercentage": { + "description": "Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.", + "format": "float", + "type": "number" + }, "failoverPolicy": { "$ref": "BackendServiceFailoverPolicy", - "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview)." + "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy." }, "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.", "format": "byte", "type": "string" }, + "haPolicy": { + "$ref": "BackendServiceHAPolicy", + "description": "Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers." + }, "healthChecks": { - "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.", + "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.", "items": { "type": "string" }, @@ -41891,7 +42182,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -41937,7 +42228,7 @@ "type": "string" }, "network": { - "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.", + "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL.", "type": "string" }, "outlierDetection": { @@ -42006,7 +42297,7 @@ "type": "string" }, "sessionAffinity": { - "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).", + "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy.", "enum": [ "CLIENT_IP", "CLIENT_IP_NO_DESTINATION", @@ -42036,7 +42327,8 @@ "description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY." }, "subsetting": { - "$ref": "Subsetting" + "$ref": "Subsetting", + "description": "subsetting cannot be specified with haPolicy." }, "timeoutSec": { "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.", @@ -42253,7 +42545,7 @@ "type": "integer" }, "defaultTtl": { - "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "format": "int32", "type": "integer" }, @@ -42278,7 +42570,7 @@ "type": "boolean" }, "serveWhileStale": { - "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", + "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "format": "int32", "type": "integer" }, @@ -42429,6 +42721,24 @@ }, "type": "object" }, + "BackendServiceHAPolicy": { + "id": "BackendServiceHAPolicy", + "properties": { + "fastIPMove": { + "description": "Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to update the leader. - >GARP_RA: Provides a method to very quickly define a new network endpoint as the leader. This method is faster than updating the leader using the haPolicy.leader API. Fast IP move works as follows: The VM hosting the network endpoint that should become the new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays active for approximately 20 minutes. After triggering fast failover, you must also appropriately set the haPolicy.leader. - The new leader instance should continue to send GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from different VM instances at the same time. If multiple instances continue to send GARP/RA packets, traffic might be routed to different destinations in an alternating order. This condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always takes priority over the leader API. Using the haPolicy.leader API to change the leader to a different instance will have no effect until the GARP/RA request becomes inactive. - The GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding rules refer to a regional backend service, you need only send a GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend service will also be moved to the sender of the GARP or RA packet. The following are the Fast IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED.", + "enum": [ + "DISABLED", + "GARP_RA" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "BackendServiceHttpCookie": { "description": "The HTTP cookie used for stateful session affinity.", "id": "BackendServiceHttpCookie", @@ -43496,6 +43806,13 @@ "CacheInvalidationRule": { "id": "CacheInvalidationRule", "properties": { + "cacheTags": { + "description": "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" @@ -43732,6 +44049,7 @@ "ACCELERATOR_OPTIMIZED_A3", "ACCELERATOR_OPTIMIZED_A3_MEGA", "ACCELERATOR_OPTIMIZED_A3_ULTRA", + "ACCELERATOR_OPTIMIZED_A4", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", @@ -43781,6 +44099,7 @@ "", "", "", + "", "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" @@ -48378,6 +48697,41 @@ }, "type": "object" }, + "GroupMaintenanceInfo": { + "description": "Maintenance Info for ReservationBlocks.", + "id": "GroupMaintenanceInfo", + "properties": { + "maintenanceOngoingCount": { + "description": "Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.", + "format": "int32", + "type": "integer" + }, + "maintenancePendingCount": { + "description": "Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.", + "format": "int32", + "type": "integer" + }, + "schedulingType": { + "description": "The type of maintenance for the reservation.", + "enum": [ + "GROUPED", + "GROUP_MAINTENANCE_TYPE_UNSPECIFIED", + "INDEPENDENT" + ], + "enumDescriptions": [ + "Maintenance on all reserved instances in the reservation is synchronized.", + "Unknown maintenance type.", + "Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." + ], + "type": "string" + }, + "upcomingGroupMaintenance": { + "$ref": "UpcomingMaintenance", + "description": "Maintenance information on this group of VMs." + } + }, + "type": "object" + }, "GuestAttributes": { "description": "A guest attributes entry.", "id": "GuestAttributes", @@ -48447,7 +48801,7 @@ "id": "GuestOsFeature", "properties": { "type": { - "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", + "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features.", "enum": [ "FEATURE_TYPE_UNSPECIFIED", "GVNIC", @@ -55128,7 +55482,7 @@ "id": "InstancesReportHostAsFaultyRequest", "properties": { "disruptionSchedule": { - "description": "The disruption schedule for the VM. Default to IMMEDIATE.", + "description": "The disruption schedule for the VM. Required field, only allows IMMEDIATE.", "enum": [ "DISRUPTION_SCHEDULE_UNSPECIFIED", "FUTURE", @@ -56119,14 +56473,16 @@ "type": "object" }, "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.", + "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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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" + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" ], "enumDescriptions": [ "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." ], "type": "string" }, @@ -57411,15 +57767,17 @@ "type": "array" }, "availableLinkTypes": { - "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR ", + "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 ", "items": { "enum": [ "LINK_TYPE_ETHERNET_100G_LR", - "LINK_TYPE_ETHERNET_10G_LR" + "LINK_TYPE_ETHERNET_10G_LR", + "LINK_TYPE_ETHERNET_400G_LR4" ], "enumDescriptions": [ "100G Ethernet, LR Optics.", - "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];", + "400G Ethernet, LR4 Optics." ], "type": "string" }, @@ -58669,6 +59027,18 @@ "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.", "type": "string" }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this machine image. These can be later modified by the setLabels method.", + "type": "object" + }, "machineImageEncryptionKey": { "$ref": "CustomerEncryptionKey", "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later." @@ -62303,7 +62673,7 @@ "type": "string" }, "peerMtu": { - "description": "Maximum Transmission Unit in bytes.", + "description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", "format": "int32", "type": "integer" }, @@ -62511,6 +62881,18 @@ ], "type": "string" }, + "allowDefaultNicAttachment": { + "description": "Specifies whether default NIC attachment is allowed.", + "enum": [ + "DEFAULT_NIC_ATTACHMENT_ALLOWED", + "DEFAULT_NIC_ATTACHMENT_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowExternalIpAccess": { "description": "Specifies whether VMs are allowed to have external IP access on network interfaces connected to this VPC.", "enum": [ @@ -62535,6 +62917,18 @@ ], "type": "string" }, + "allowIpForwarding": { + "description": "Specifies whether IP forwarding is allowed.", + "enum": [ + "IP_FORWARDING_ALLOWED", + "IP_FORWARDING_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowLoadBalancing": { "description": "Specifies whether cloud load balancing is allowed.", "enum": [ @@ -62559,6 +62953,30 @@ ], "type": "string" }, + "allowNcc": { + "description": "Specifies whether NCC is allowed.", + "enum": [ + "NCC_ALLOWED", + "NCC_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "allowNetworkMigration": { + "description": "Specifies whether VM network migration is allowed.", + "enum": [ + "NETWORK_MIGRATION_ALLOWED", + "NETWORK_MIGRATION_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowPacketMirroring": { "description": "Specifies whether Packet Mirroring 1.0 is supported.", "enum": [ @@ -62710,6 +63128,50 @@ }, "type": "array" }, + "subnetworkPurposes": { + "description": "Specifies which subnetwork purposes are supported.", + "items": { + "enum": [ + "GLOBAL_MANAGED_PROXY", + "INTERNAL_HTTPS_LOAD_BALANCER", + "PEER_MIGRATION", + "PRIVATE", + "PRIVATE_NAT", + "PRIVATE_RFC_1918", + "PRIVATE_SERVICE_CONNECT", + "REGIONAL_MANAGED_PROXY" + ], + "enumDescriptions": [ + "Subnet reserved for Global Envoy-based Load Balancing.", + "Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.", + "Subnetwork will be used for Migration from one peered VPC to another. (a transient state of subnetwork while migrating resources from one project to another).", + "Regular user created or automatically created subnet.", + "Subnetwork used as source range for Private NAT Gateways.", + "Regular user created or automatically created subnet.", + "Subnetworks created for Private Service Connect in the producer network.", + "Subnetwork used for Regional Envoy-based Load Balancing." + ], + "type": "string" + }, + "type": "array" + }, + "subnetworkStackTypes": { + "description": "Specifies which subnetwork stack types are supported.", + "items": { + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY", + "IPV6_ONLY" + ], + "enumDescriptions": [ + "New VMs in this subnet can have both IPv4 and IPv6 addresses.", + "New VMs in this subnet will only be assigned IPv4 addresses.", + "New VMs in this subnet will only be assigned IPv6 addresses." + ], + "type": "string" + }, + "type": "array" + }, "unicast": { "description": "Specifies which type of unicast is supported.", "enum": [ @@ -70484,6 +70946,18 @@ "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "deploymentType": { + "description": "Specifies the deployment strategy for this reservation.", + "enum": [ + "DENSE", + "DEPLOYMENT_TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The reserved capacity is made up of densely deployed reservation blocks.", + "" + ], + "type": "string" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -70498,6 +70972,13 @@ "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", "type": "string" }, + "linkedCommitments": { + "description": "[Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.", + "items": { + "type": "string" + }, + "type": "array" + }, "name": { "annotations": { "required": [ @@ -70765,6 +71246,255 @@ }, "type": "object" }, + "ReservationBlock": { + "description": "Represents a reservation block resource.", + "id": "ReservationBlock", + "properties": { + "count": { + "description": "[Output Only] The number of resources that are allocated in this reservation block.", + "format": "int32", + "type": "integer" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "inUseCount": { + "description": "[Output Only] The number of instances that are currently in use on this reservation block.", + "format": "int32", + "type": "integer" + }, + "kind": { + "default": "compute#reservationBlock", + "description": "[Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.", + "type": "string" + }, + "name": { + "description": "[Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "physicalTopology": { + "$ref": "ReservationBlockPhysicalTopology", + "description": "[Output Only] The physical topology of the reservation block." + }, + "reservationMaintenance": { + "$ref": "GroupMaintenanceInfo", + "description": "[Output Only] Maintenance information for this reservation block." + }, + "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": { + "description": "[Output Only] Status of the reservation block.", + "enum": [ + "CREATING", + "DELETING", + "INVALID", + "READY" + ], + "enumDescriptions": [ + "Resources are being allocated for the reservation block.", + "Reservation block is currently being deleted.", + "", + "Reservation block has allocated all its resources." + ], + "type": "string" + }, + "zone": { + "description": "[Output Only] Zone in which the reservation block resides.", + "type": "string" + } + }, + "type": "object" + }, + "ReservationBlockPhysicalTopology": { + "id": "ReservationBlockPhysicalTopology", + "properties": { + "block": { + "description": "The hash of the capacity block within the cluster.", + "type": "string" + }, + "cluster": { + "description": "The cluster name of the reservation block.", + "type": "string" + } + }, + "type": "object" + }, + "ReservationBlocksGetResponse": { + "id": "ReservationBlocksGetResponse", + "properties": { + "resource": { + "$ref": "ReservationBlock" + } + }, + "type": "object" + }, + "ReservationBlocksListResponse": { + "description": "A list of reservation blocks under a single reservation.", + "id": "ReservationBlocksListResponse", + "properties": { + "id": { + "description": "Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of reservation block resources.", + "items": { + "$ref": "ReservationBlock" + }, + "type": "array" + }, + "kind": { + "default": "compute#reservationBlock", + "description": "Type of the resource. Always compute#reservationBlock for a list of reservation blocks.", + "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": "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" + }, "ReservationList": { "id": "ReservationList", "properties": { @@ -70919,6 +71649,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": { @@ -73375,6 +74149,13 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "nat64Subnetworks": { + "description": "List of Subnetwork resources whose traffic should be translated by NAT64 Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is selected for the SubnetworkIpRangeToNat64Option above.", + "items": { + "$ref": "RouterNatSubnetworkToNat64" + }, + "type": "array" + }, "natIpAllocateOption": { "description": "Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. ", "enum": [ @@ -73415,6 +74196,18 @@ ], "type": "string" }, + "sourceSubnetworkIpRangesToNat64": { + "description": "Specify the Nat option for NAT64, which can take one of the following values: - ALL_IPV6_SUBNETWORKS: All of the IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field nat64_subnetwork below) The default is NAT64_OPTION_UNSPECIFIED. Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other Router.Nat section in this region can also enable NAT64 for any Subnetworks in this network. Other Router.Nat sections can still be present to enable NAT44 only.", + "enum": [ + "ALL_IPV6_SUBNETWORKS", + "LIST_OF_IPV6_SUBNETWORKS" + ], + "enumDescriptions": [ + "NAT64 is enabled for all the IPv6 subnet ranges. In dual stack subnets, NAT64 will only be enabled for IPv6-only VMs.", + "NAT64 is enabled for a list of IPv6 subnet ranges. In dual stack subnets, NAT64 will only be enabled for IPv6-only VMs. If this option is used, the nat64_subnetworks field must be specified." + ], + "type": "string" + }, "subnetworks": { "description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.", "items": { @@ -73574,6 +74367,17 @@ }, "type": "object" }, + "RouterNatSubnetworkToNat64": { + "description": "Specifies a subnetwork to enable NAT64.", + "id": "RouterNatSubnetworkToNat64", + "properties": { + "name": { + "description": "URL for the subnetwork resource that will use NAT64.", + "type": "string" + } + }, + "type": "object" + }, "RouterStatus": { "id": "RouterStatus", "properties": { @@ -76894,7 +77698,7 @@ "type": "object" }, "Snapshot": { - "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", + "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", "id": "Snapshot", "properties": { "architecture": { @@ -76946,6 +77750,10 @@ "description": "Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", "type": "boolean" }, + "guestFlush": { + "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.", + "type": "boolean" + }, "guestOsFeatures": { "description": "[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", "items": { @@ -80378,7 +81186,6 @@ "type": "string" }, "purpose": { - "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", @@ -85652,7 +86459,6 @@ "type": "string" }, "purpose": { - "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/discovery/config-v1.json b/discovery/config-v1.json index c195547b742..ff86397ee34 100644 --- a/discovery/config-v1.json +++ b/discovery/config-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1187,7 +1193,7 @@ } } }, - "revision": "20250219", + "revision": "20250409", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index c5d58a06311..84e29bc6708 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -193,6 +193,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1954,6 +1960,11 @@ "pattern": "^projects/[^/]+/locations/global$", "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}/managedZones", @@ -2560,7 +2571,7 @@ } } }, - "revision": "20250304", + "revision": "20250423", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -3587,6 +3598,10 @@ "description": "Indicate whether cloud spanner is required for connector job.", "type": "boolean" }, + "provisionMemstore": { + "description": "Indicate whether memstore is required for connector job.", + "type": "boolean" + }, "ratelimitThreshold": { "description": "Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -3666,11 +3681,6 @@ "description": "Output only. Eventing configuration supported by the Connector.", "readOnly": true }, - "isAsyncOperationsSupported": { - "description": "Output only. Is async operations supported.", - "readOnly": true, - "type": "boolean" - }, "isCustomActionsSupported": { "description": "Output only. Is custom actions supported.", "readOnly": true, @@ -3958,12 +3968,14 @@ "enum": [ "CUSTOM_CONNECTOR_TYPE_UNSPECIFIED", "OPEN_API", - "PROTO" + "PROTO", + "SDK" ], "enumDescriptions": [ "Connector type is not specified.", "OpenAPI connector.", - "Proto connector." + "Proto connector.", + "SDK connector." ], "type": "string" }, @@ -4011,12 +4023,27 @@ "description": "CustomConnectorVersion indicates a specific version of a connector.", "id": "CustomConnectorVersion", "properties": { + "asyncOperationsSupport": { + "description": "Optional. Indicates if Async Operations/Connector Job is supported. This is only available for SDK based custom connectors.", + "type": "boolean" + }, "authConfig": { "$ref": "AuthConfig", - "description": "Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true." + "description": "Optional. Authentication config for accessing connector service (facade). This is used only when enable_backend_destination_config is true." + }, + "authConfigTemplates": { + "description": "Optional. Auth Config Templates is only used when connector backend is enabled. This is used to specify the auth configs supported by the connector backend service to talk to the actual application backend.", + "items": { + "$ref": "AuthConfigTemplate" + }, + "type": "array" + }, + "authOverrideSupport": { + "description": "Optional. Auth override support.", + "type": "boolean" }, "backendVariableTemplates": { - "description": "Optional. Backend variables config templates. This translates to additional variable templates in connection.", + "description": "Optional. Backend variable templates is only used when connector backend is enabled. This is used to specify the variables required by the connector backend service to talk to the actual application backend. This translates to additional variable templates in the connection config.", "items": { "$ref": "ConfigVariableTemplate" }, @@ -4029,14 +4056,14 @@ "type": "string" }, "destinationConfigs": { - "description": "Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.", + "description": "Optional. Destination config(s) for accessing connector service (facade). This is used only when enable_backend_destination_config is true.", "items": { "$ref": "DestinationConfig" }, "type": "array" }, "enableBackendDestinationConfig": { - "description": "Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.", + "description": "Optional. Indicates if an intermediatory connectorservice is used as backend. When this is enabled, the connector destination and connector auth config are required. For SDK based connectors, this is always enabled.", "type": "boolean" }, "labels": { @@ -4065,11 +4092,11 @@ "type": "string" }, "specLocation": { - "description": "Optional. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`", + "description": "Optional. Location of the custom connector spec. This is only used for Open API based custom connectors. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`.", "type": "string" }, "specServerUrls": { - "description": "Output only. Server URLs parsed from the spec.", + "description": "Output only. Server URLs parsed from the Open API spec. This is only used for Open API based custom connectors.", "items": { "type": "string" }, @@ -4641,7 +4668,7 @@ "type": "object" }, "EventingConfig": { - "description": "Eventing Configuration of a connection", + "description": "Eventing Configuration of a connection next: 18", "id": "EventingConfig", "properties": { "additionalVariables": { @@ -4686,12 +4713,16 @@ "registrationDestinationConfig": { "$ref": "DestinationConfig", "description": "Optional. Registration endpoint for auto registration." + }, + "sslConfig": { + "$ref": "SslConfig", + "description": "Optional. Ssl config of a connection" } }, "type": "object" }, "EventingConfigTemplate": { - "description": "Eventing Config details of a connector version.", + "description": "Eventing Config details of a connector version. next: 14", "id": "EventingConfigTemplate", "properties": { "additionalVariables": { @@ -4757,6 +4788,10 @@ "$ref": "DestinationConfigTemplate", "description": "Registration host destination config template." }, + "sslConfigTemplate": { + "$ref": "SslConfigTemplate", + "description": "SSL Config template for the connector version." + }, "triggerConfigVariables": { "description": "Trigger Config fields that needs to be rendered", "items": { @@ -5414,6 +5449,10 @@ "description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).", "type": "string" }, + "consumerProjectNumber": { + "description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "format": "google-datetime", @@ -6056,6 +6095,13 @@ "nextPageToken": { "description": "Next page token.", "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -7971,6 +8017,10 @@ "description": "Specifies if the connector supports action apis like 'executeAction'.", "type": "boolean" }, + "asyncOperations": { + "description": "Specifies if the connector supports async long running operations.", + "type": "boolean" + }, "entityApis": { "description": "Specifies if the connector supports entity apis like 'createEntity'.", "type": "boolean" @@ -8124,12 +8174,14 @@ "enum": [ "CUSTOM_CONNECTOR_TYPE_UNSPECIFIED", "OPEN_API", - "PROTO" + "PROTO", + "SDK" ], "enumDescriptions": [ "Connector type is not specified.", "OpenAPI connector.", - "Proto connector." + "Proto connector.", + "SDK connector." ], "type": "string" } diff --git a/discovery/connectors-v2.json b/discovery/connectors-v2.json index e1dd1dbadad..39c7f12f9b7 100644 --- a/discovery/connectors-v2.json +++ b/discovery/connectors-v2.json @@ -288,6 +288,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Specified view of the action schema.", + "enum": [ + "ACTION_SCHEMA_VIEW_UNSPECIFIED", + "ACTION_SCHEMA_VIEW_BASIC", + "ACTION_SCHEMA_VIEW_ENRICHED" + ], + "enumDescriptions": [ + "VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.", + "Return basic action schema.", + "Return enriched action schema." + ], + "location": "query", + "type": "string" } }, "path": "v2/{+name}", @@ -675,7 +690,7 @@ } } }, - "revision": "20250304", + "revision": "20250423", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -1380,6 +1395,10 @@ "description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).", "type": "string" }, + "consumerProjectNumber": { + "description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "format": "google-datetime", diff --git a/discovery/contactcenteraiplatform-v1alpha1.json b/discovery/contactcenteraiplatform-v1alpha1.json index 77bf3c362b7..e2e008f2d49 100644 --- a/discovery/contactcenteraiplatform-v1alpha1.json +++ b/discovery/contactcenteraiplatform-v1alpha1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -512,7 +518,7 @@ } } }, - "revision": "20250205", + "revision": "20250414", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -562,6 +568,10 @@ "$ref": "AdminUser", "description": "Optional. Info about the first admin user, such as given name and family name." }, + "advancedReportingEnabled": { + "description": "Optional. Whether the advanced reporting feature is enabled.", + "type": "boolean" + }, "ccaipManagedUsers": { "description": "Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity", "type": "boolean" diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 23d26670260..df38bc80bea 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -536,6 +536,34 @@ "resources": { "conversations": { "methods": { + "bulkAnalyze": { + "description": "Analyzes multiple conversations in a single request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:bulkAnalyze", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.bulkAnalyze", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource to create analyses in.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/conversations:bulkAnalyze", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "calculateStats": { "description": "Gets conversation statistics.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats", @@ -565,6 +593,519 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "delete": { + "description": "Deletes a conversation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the conversation to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a conversation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the conversation to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The level of details of the conversation. Default is `FULL`.", + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC" + ], + "enumDescriptions": [ + "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1Conversation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists conversations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the conversation.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The level of details of the conversation. Default is `BASIC`.", + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC" + ], + "enumDescriptions": [ + "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/conversations", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "analyses": { + "methods": { + "create": { + "description": "Creates an analysis. The long running operation is done when the analysis has completed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the analysis.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/analyses", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1Analysis" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an analysis.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the analysis to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an analysis.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the analysis to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1Analysis" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists analyses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the analyses.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/analyses", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "feedbackLabels": { + "methods": { + "create": { + "description": "Create feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "feedbackLabelId": { + "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the feedback label.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/feedbackLabels", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the feedback label to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the feedback label to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List feedback labels.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. 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", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the feedback labels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/feedbackLabels", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", + "httpMethod": "PATCH", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "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}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/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}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.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/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "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" + ] } } } @@ -1203,6 +1744,205 @@ } } }, + "datasets": { + "resources": { + "conversations": { + "methods": { + "delete": { + "description": "Deletes a conversation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.datasets.conversations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the conversation to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a conversation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.conversations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the conversation to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The level of details of the conversation. Default is `FULL`.", + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC" + ], + "enumDescriptions": [ + "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1Conversation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "ingest": { + "description": "Imports conversations and processes them according to the user's configuration.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.conversations.ingest", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for new conversations.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/conversations:ingest", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists conversations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.conversations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the conversation.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The level of details of the conversation. Default is `BASIC`.", + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC" + ], + "enumDescriptions": [ + "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/conversations", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "insightsdata": { + "methods": { + "export": { + "description": "Export insights data to a destination defined in the request body.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.insightsdata.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource to export data from.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/insightsdata:export", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "encryptionSpec": { "methods": { "initialize": { @@ -2637,7 +3377,7 @@ } } }, - "revision": "20250311", + "revision": "20250428", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -3253,12 +3993,14 @@ "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", - "TOPIC_MODELING" + "TOPIC_MODELING", + "AGENT_ASSIST_SUMMARY" ], "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", - "Downloaded file will contain only Topic Modeling labels." + "Downloaded file will contain only Topic Modeling labels.", + "Agent Assist Summarization labels." ], "type": "string" }, @@ -3279,6 +4021,10 @@ "description": "Required. The parent resource for new feedback labels.", "type": "string" }, + "sheetsDestination": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination", + "description": "A sheets document destination." + }, "templateQaScorecardId": { "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.", "items": { @@ -3327,6 +4073,21 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { + "description": "Google Sheets document details to write the feedback labels to.", + "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination", + "properties": { + "sheetTitle": { + "description": "Optional. The title of the new sheet to write the feedback labels to.", + "type": "string" + }, + "spreadsheetUri": { + "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", @@ -3341,6 +4102,10 @@ "$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource", "description": "A cloud storage bucket source." }, + "sheetsSource": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource", + "description": "A sheets document source." + }, "validateOnly": { "description": "Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete.", "type": "boolean" @@ -3373,6 +4138,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource": { + "description": "Google Sheets document details to get the feedback label file from.", + "id": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource", + "properties": { + "spreadsheetUri": { + "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse": { "description": "Response of querying an issue model's statistics.", "id": "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse", @@ -4680,7 +5456,7 @@ "type": "object" }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { - "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.", + "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. AgentAssistSummary labels are used for Agent Assist Summarization.", "id": "GoogleCloudContactcenterinsightsV1FeedbackLabel", "properties": { "createTime": { @@ -4694,7 +5470,7 @@ "type": "string" }, "labeledResource": { - "description": "Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model}", + "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" }, "name": { @@ -6355,6 +7131,23 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { + "description": "The metadata for querying performance overview.", + "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { + "description": "The response for querying performance overview.", + "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse", + "properties": { + "summaryText": { + "description": "The summary text of the performance.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1RedactionConfig": { "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "id": "GoogleCloudContactcenterinsightsV1RedactionConfig", @@ -8443,7 +9236,7 @@ "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { - "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.", + "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. AgentAssistSummary labels are used for Agent Assist Summarization.", "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel", "properties": { "createTime": { @@ -8457,7 +9250,7 @@ "type": "string" }, "labeledResource": { - "description": "Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model}", + "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" }, "name": { @@ -9530,6 +10323,23 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { + "description": "The metadata for querying performance overview.", + "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { + "description": "The response for querying performance overview.", + "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse", + "properties": { + "summaryText": { + "description": "The summary text of the performance.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "id": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 551f2eb718b..dece0ac20e8 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -323,6 +323,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "fetchClusterUpgradeInfo": { + "description": "Fetch upgrade information of a specific cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:fetchClusterUpgradeInfo", + "httpMethod": "GET", + "id": "container.projects.locations.clusters.fetchClusterUpgradeInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/*/locations/*/clusters/*` or `projects/*/zones/*/clusters/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "version": { + "description": "API request version that initiates this operation.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:fetchClusterUpgradeInfo", + "response": { + "$ref": "ClusterUpgradeInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the details of a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", @@ -871,6 +901,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "fetchNodePoolUpgradeInfo": { + "description": "Fetch upgrade information of a specific nodepool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", + "httpMethod": "GET", + "id": "container.projects.locations.clusters.nodePools.fetchNodePoolUpgradeInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", + "required": true, + "type": "string" + }, + "version": { + "description": "API request version that initiates this operation.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:fetchNodePoolUpgradeInfo", + "response": { + "$ref": "NodePoolUpgradeInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Retrieves the requested node pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", @@ -1448,6 +1508,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "fetchClusterUpgradeInfo": { + "description": "Fetch upgrade information of a specific cluster.", + "flatPath": "v1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}:fetchClusterUpgradeInfo", + "httpMethod": "GET", + "id": "container.projects.zones.clusters.fetchClusterUpgradeInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/*/locations/*/clusters/*` or `projects/*/zones/*/clusters/*`.", + "location": "path", + "pattern": "^projects/[^/]+/zones/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "version": { + "description": "API request version that initiates this operation.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:fetchClusterUpgradeInfo", + "response": { + "$ref": "ClusterUpgradeInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the details of a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", @@ -2122,6 +2212,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "fetchNodePoolUpgradeInfo": { + "description": "Fetch upgrade information of a specific nodepool.", + "flatPath": "v1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", + "httpMethod": "GET", + "id": "container.projects.zones.clusters.nodePools.fetchNodePoolUpgradeInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", + "location": "path", + "pattern": "^projects/[^/]+/zones/[^/]+/clusters/[^/]+/nodePools/[^/]+$", + "required": true, + "type": "string" + }, + "version": { + "description": "API request version that initiates this operation.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:fetchNodePoolUpgradeInfo", + "response": { + "$ref": "NodePoolUpgradeInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Retrieves the requested node pool.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", @@ -2540,7 +2660,7 @@ } } }, - "revision": "20250225", + "revision": "20250408", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2890,7 +3010,7 @@ "type": "string" }, "insecureKubeletReadonlyPortEnabled": { - "description": "Enable or disable Kubelet read only port.", + "description": "DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.", "type": "boolean" }, "management": { @@ -3321,6 +3441,7 @@ "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" }, @@ -3361,7 +3482,7 @@ "description": "Monitoring configuration for the cluster." }, "monitoringService": { - "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", + "description": "The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "name": { @@ -3414,6 +3535,10 @@ "$ref": "ParentProductConfig", "description": "The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster." }, + "podAutoscaling": { + "$ref": "PodAutoscaling", + "description": "The config for pod autoscaling." + }, "privateClusterConfig": { "$ref": "PrivateClusterConfig", "description": "Configuration for private cluster." @@ -3769,7 +3894,7 @@ "description": "The desired monitoring configuration." }, "desiredMonitoringService": { - "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", + "description": "The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "desiredNetworkPerformanceConfig": { @@ -3820,6 +3945,10 @@ "$ref": "ParentProductConfig", "description": "The desired parent product config for the cluster." }, + "desiredPodAutoscaling": { + "$ref": "PodAutoscaling", + "description": "The desired config for pod autoscaling." + }, "desiredPrivateClusterConfig": { "$ref": "PrivateClusterConfig", "deprecated": true, @@ -3910,6 +4039,80 @@ }, "type": "object" }, + "ClusterUpgradeInfo": { + "description": "ClusterUpgradeInfo contains the upgrade information of a cluster.", + "id": "ClusterUpgradeInfo", + "properties": { + "autoUpgradeStatus": { + "description": "The auto upgrade status.", + "items": { + "enum": [ + "UNKNOWN", + "ACTIVE", + "MINOR_UPGRADE_PAUSED", + "UPGRADE_PAUSED" + ], + "enumDescriptions": [ + "UNKNOWN indicates an unknown status.", + "ACTIVE indicates an active status.", + "MINOR_UPGRADE_PAUSED indicates the minor version upgrade is paused.", + "UPGRADE_PAUSED indicates the upgrade is paused." + ], + "type": "string" + }, + "type": "array" + }, + "endOfExtendedSupportTimestamp": { + "description": "The cluster's current minor version's end of extended support timestamp.", + "type": "string" + }, + "endOfStandardSupportTimestamp": { + "description": "The cluster's current minor version's end of standard support timestamp.", + "type": "string" + }, + "minorTargetVersion": { + "description": "minor_target_version indicates the target version for minor upgrade.", + "type": "string" + }, + "patchTargetVersion": { + "description": "patch_target_version indicates the target version for patch upgrade.", + "type": "string" + }, + "pausedReason": { + "description": "The auto upgrade paused reason.", + "items": { + "enum": [ + "AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED", + "MAINTENANCE_WINDOW", + "MAINTENANCE_EXCLUSION_NO_UPGRADES", + "MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES", + "CLUSTER_DISRUPTION_BUDGET", + "CLUSTER_DISRUPTION_BUDGET_MINOR_UPGRADE", + "SYSTEM_CONFIG" + ], + "enumDescriptions": [ + "AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED indicates an unspecified reason.", + "MAINTENANCE_WINDOW indicates the cluster is outside customer maintenance window.", + "MAINTENANCE_EXCLUSION_NO_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_UPGRADES.", + "MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_MINOR_UPGRADES.", + "CLUSTER_DISRUPTION_BUDGET indicates the cluster is outside the cluster disruption budget.", + "CLUSTER_DISRUPTION_BUDGET_MINOR_UPGRADE indicates the cluster is outside the cluster disruption budget for minor version upgrade.", + "SYSTEM_CONFIG indicates the cluster upgrade is paused by system config." + ], + "type": "string" + }, + "type": "array" + }, + "upgradeDetails": { + "description": "The list of past auto upgrades.", + "items": { + "$ref": "UpgradeDetails" + }, + "type": "array" + } + }, + "type": "object" + }, "CompleteIPRotationRequest": { "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.", "id": "CompleteIPRotationRequest", @@ -3985,6 +4188,22 @@ "description": "ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.", "id": "ConfidentialNodes", "properties": { + "confidentialInstanceType": { + "description": "Defines the type of technology used by the confidential node.", + "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" + }, "enabled": { "description": "Whether Confidential Nodes feature is enabled.", "type": "boolean" @@ -4336,6 +4555,11 @@ "description": "EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.", "id": "EphemeralStorageLocalSsdConfig", "properties": { + "dataCacheCount": { + "description": "Number of local SSDs to use for GKE Data Cache.", + "format": "int32", + "type": "integer" + }, "localSsdCount": { "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", @@ -5651,6 +5875,10 @@ "$ref": "FastSocket", "description": "Enable or disable NCCL fast socket for the node pool." }, + "flexStart": { + "description": "Flex Start flag for enabling Flex Start VM.", + "type": "boolean" + }, "gcfsConfig": { "$ref": "GcfsConfig", "description": "Google Container File System (image streaming) configs." @@ -5993,7 +6221,7 @@ "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" + "description": "Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler." }, "autoscaling": { "$ref": "NodePoolAutoscaling", @@ -6213,6 +6441,76 @@ }, "type": "object" }, + "NodePoolUpgradeInfo": { + "description": "NodePoolUpgradeInfo contains the upgrade information of a nodepool.", + "id": "NodePoolUpgradeInfo", + "properties": { + "autoUpgradeStatus": { + "description": "The auto upgrade status.", + "items": { + "enum": [ + "UNKNOWN", + "ACTIVE", + "MINOR_UPGRADE_PAUSED", + "UPGRADE_PAUSED" + ], + "enumDescriptions": [ + "UNKNOWN indicates an unknown status.", + "ACTIVE indicates an active status.", + "MINOR_UPGRADE_PAUSED indicates the minor version upgrade is paused.", + "UPGRADE_PAUSED indicates the upgrade is paused." + ], + "type": "string" + }, + "type": "array" + }, + "endOfExtendedSupportTimestamp": { + "description": "The nodepool's current minor version's end of extended support timestamp.", + "type": "string" + }, + "endOfStandardSupportTimestamp": { + "description": "The nodepool's current minor version's end of standard support timestamp.", + "type": "string" + }, + "minorTargetVersion": { + "description": "minor_target_version indicates the target version for minor upgrade.", + "type": "string" + }, + "patchTargetVersion": { + "description": "patch_target_version indicates the target version for patch upgrade.", + "type": "string" + }, + "pausedReason": { + "description": "The auto upgrade paused reason.", + "items": { + "enum": [ + "AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED", + "MAINTENANCE_WINDOW", + "MAINTENANCE_EXCLUSION_NO_UPGRADES", + "MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES", + "SYSTEM_CONFIG" + ], + "enumDescriptions": [ + "AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED indicates an unspecified reason.", + "MAINTENANCE_WINDOW indicates the cluster is outside customer maintenance window.", + "MAINTENANCE_EXCLUSION_NO_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_UPGRADES.", + "MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES indicates the cluster is in a maintenance exclusion with scope NO_MINOR_UPGRADES.", + "SYSTEM_CONFIG indicates the cluster upgrade is paused by system config." + ], + "type": "string" + }, + "type": "array" + }, + "upgradeDetails": { + "description": "The list of past auto upgrades.", + "items": { + "$ref": "UpgradeDetails" + }, + "type": "array" + } + }, + "type": "object" + }, "NodeTaint": { "description": "Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.", "id": "NodeTaint", @@ -6554,6 +6852,27 @@ }, "type": "object" }, + "PodAutoscaling": { + "description": "PodAutoscaling is used for configuration of parameters for workload autoscaling.", + "id": "PodAutoscaling", + "properties": { + "hpaProfile": { + "description": "Selected Horizontal Pod Autoscaling profile.", + "enum": [ + "HPA_PROFILE_UNSPECIFIED", + "NONE", + "PERFORMANCE" + ], + "enumDescriptions": [ + "HPA_PROFILE_UNSPECIFIED is used when no custom HPA profile is set.", + "Customers explicitly opt-out of HPA profiles.", + "PERFORMANCE is used when customers opt-in to the performance HPA profile. In this profile we support a higher number of HPAs per cluster and faster metrics collection for workload autoscaling." + ], + "type": "string" + } + }, + "type": "object" + }, "PodCIDROverprovisionConfig": { "description": "[PRIVATE FIELD] Config for pod CIDR size overprovisioning.", "id": "PodCIDROverprovisionConfig", @@ -7056,6 +7375,13 @@ "description": "If this field is specified, it means there are manual steps that the user must take to make their clusters safe.", "type": "boolean" }, + "mitigatedVersions": { + "description": "The GKE versions where this vulnerability is mitigated.", + "items": { + "type": "string" + }, + "type": "array" + }, "patchedVersions": { "description": "The GKE versions where this vulnerability is patched.", "items": { @@ -7414,7 +7740,7 @@ "type": "string" }, "monitoringService": { - "description": "Required. The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", + "description": "Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "name": { @@ -7911,6 +8237,10 @@ "$ref": "FastSocket", "description": "Enable or disable NCCL fast socket for the node pool." }, + "flexStart": { + "description": "Flex Start flag for enabling Flex Start VM.", + "type": "boolean" + }, "gcfsConfig": { "$ref": "GcfsConfig", "description": "GCFS config." @@ -8057,6 +8387,64 @@ }, "type": "object" }, + "UpgradeDetails": { + "description": "UpgradeDetails contains detailed information of each individual upgrade operation.", + "id": "UpgradeDetails", + "properties": { + "endTime": { + "description": "The end timestamp of the upgrade.", + "format": "google-datetime", + "type": "string" + }, + "initialVersion": { + "description": "The version before the upgrade.", + "type": "string" + }, + "startTime": { + "description": "The start timestamp of the upgrade.", + "format": "google-datetime", + "type": "string" + }, + "startType": { + "description": "The start type of the upgrade.", + "enum": [ + "START_TYPE_UNSPECIFIED", + "AUTOMATIC", + "MANUAL" + ], + "enumDescriptions": [ + "Upgrade start type is unspecified.", + "Upgrade started automatically.", + "Upgrade started manually." + ], + "type": "string" + }, + "state": { + "description": "Output only. The state of the upgrade.", + "enum": [ + "UNKNOWN", + "FAILED", + "SUCCEEDED", + "CANCELED", + "RUNNING" + ], + "enumDescriptions": [ + "Upgrade state is unknown.", + "Upgrade has failed with an error.", + "Upgrade has succeeded.", + "Upgrade has been canceled.", + "Upgrade is running." + ], + "readOnly": true, + "type": "string" + }, + "targetVersion": { + "description": "The version after the upgrade.", + "type": "string" + } + }, + "type": "object" + }, "UpgradeEvent": { "description": "UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.", "id": "UpgradeEvent", @@ -8121,12 +8509,14 @@ "enum": [ "EVENT_TYPE_UNSPECIFIED", "END_OF_SUPPORT", - "COS_MILESTONE_VERSION_UPDATE" + "COS_MILESTONE_VERSION_UPDATE", + "UPGRADE_LIFECYCLE" ], "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.", - "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." + "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.", + "UPGRADE_LIFECYCLE indicates the event is about the upgrade lifecycle." ], "type": "string" }, @@ -8359,20 +8749,20 @@ "type": "object" }, "WindowsNodeConfig": { - "description": "Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings", + "description": "Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings.", "id": "WindowsNodeConfig", "properties": { "osVersion": { - "description": "OSVersion specifies the Windows node config to be used on the node", + "description": "OSVersion specifies the Windows node config to be used on the node.", "enum": [ "OS_VERSION_UNSPECIFIED", "OS_VERSION_LTSC2019", "OS_VERSION_LTSC2022" ], "enumDescriptions": [ - "When OSVersion is not specified", - "LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base Image", - "LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base Image" + "When OSVersion is not specified.", + "LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base Image.", + "LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base Image." ], "type": "string" } diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index f4ed36dd397..34ef5079b57 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2685,7 +2685,7 @@ } } }, - "revision": "20250225", + "revision": "20250408", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3076,7 +3076,7 @@ "type": "string" }, "insecureKubeletReadonlyPortEnabled": { - "description": "Enable or disable Kubelet read only port.", + "description": "DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.", "type": "boolean" }, "management": { @@ -3600,7 +3600,7 @@ "description": "Monitoring configuration for the cluster." }, "monitoringService": { - "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", + "description": "The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "name": { @@ -4074,7 +4074,7 @@ "description": "The desired monitoring configuration." }, "desiredMonitoringService": { - "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", + "description": "The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "desiredNetworkPerformanceConfig": { @@ -4395,6 +4395,22 @@ "description": "ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.", "id": "ConfidentialNodes", "properties": { + "confidentialInstanceType": { + "description": "Defines the type of technology used by the confidential node.", + "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" + }, "enabled": { "description": "Whether Confidential Nodes feature is enabled.", "type": "boolean" @@ -4780,6 +4796,11 @@ "description": "EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.", "id": "EphemeralStorageLocalSsdConfig", "properties": { + "dataCacheCount": { + "description": "Number of local SSDs to use for GKE Data Cache.", + "format": "int32", + "type": "integer" + }, "localSsdCount": { "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", @@ -6211,7 +6232,7 @@ "description": "Parameters for containerd customization." }, "diskSizeGb": { - "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.", + "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. TODO(b/395671893) - Deprecate disk_size_gb and disk_type fields. If unspecified, the default disk size is 100GB.", "format": "int32", "type": "integer" }, @@ -6250,6 +6271,10 @@ "$ref": "FastSocket", "description": "Enable or disable NCCL fast socket for the node pool." }, + "flexStart": { + "description": "Flex Start flag for enabling Flex Start VM.", + "type": "boolean" + }, "gcfsConfig": { "$ref": "GcfsConfig", "description": "GCFS (Google Container File System) configs." @@ -6600,7 +6625,7 @@ "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" + "description": "Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler." }, "autoscaling": { "$ref": "NodePoolAutoscaling", @@ -7738,6 +7763,22 @@ }, "type": "object" }, + "RotationConfig": { + "description": "RotationConfig is config for secret manager auto rotation.", + "id": "RotationConfig", + "properties": { + "enabled": { + "description": "Whether the rotation is enabled.", + "type": "boolean" + }, + "rotationInterval": { + "description": "The interval between two consecutive rotations. Default rotation interval is 2 minutes.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "SandboxConfig": { "description": "SandboxConfig contains configurations of the sandbox to use for the node.", "id": "SandboxConfig", @@ -7798,6 +7839,10 @@ "enabled": { "description": "Enable/Disable Secret Manager Config.", "type": "boolean" + }, + "rotationConfig": { + "$ref": "RotationConfig", + "description": "Rotation config for secret manager." } }, "type": "object" @@ -7836,6 +7881,13 @@ "description": "If this field is specified, it means there are manual steps that the user must take to make their clusters safe.", "type": "boolean" }, + "mitigatedVersions": { + "description": "The GKE versions where this vulnerability is mitigated.", + "items": { + "type": "string" + }, + "type": "array" + }, "patchedVersions": { "description": "The GKE versions where this vulnerability is patched.", "items": { @@ -8201,7 +8253,7 @@ "type": "string" }, "monitoringService": { - "description": "Required. The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", + "description": "Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, "name": { @@ -8718,6 +8770,10 @@ "$ref": "FastSocket", "description": "Enable or disable NCCL fast socket for the node pool." }, + "flexStart": { + "description": "Flex Start flag for enabling Flex Start VM.", + "type": "boolean" + }, "gcfsConfig": { "$ref": "GcfsConfig", "description": "GCFS config." @@ -8886,6 +8942,20 @@ "format": "google-datetime", "type": "string" }, + "startType": { + "description": "The start type of the upgrade.", + "enum": [ + "START_TYPE_UNSPECIFIED", + "AUTOMATIC", + "MANUAL" + ], + "enumDescriptions": [ + "Upgrade start type is unspecified.", + "Upgrade started automatically.", + "Upgrade started manually." + ], + "type": "string" + }, "state": { "description": "Output only. The state of the upgrade.", "enum": [ @@ -8976,12 +9046,14 @@ "enum": [ "EVENT_TYPE_UNSPECIFIED", "END_OF_SUPPORT", - "COS_MILESTONE_VERSION_UPDATE" + "COS_MILESTONE_VERSION_UPDATE", + "UPGRADE_LIFECYCLE" ], "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.", - "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." + "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.", + "UPGRADE_LIFECYCLE indicates the event is about the upgrade lifecycle." ], "type": "string" }, @@ -9214,11 +9286,11 @@ "type": "object" }, "WindowsNodeConfig": { - "description": "Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings", + "description": "Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings.", "id": "WindowsNodeConfig", "properties": { "osVersion": { - "description": "OSVersion specifies the Windows node config to be used on the node", + "description": "OSVersion specifies the Windows node config to be used on the node.", "enum": [ "OS_VERSION_UNSPECIFIED", "OS_VERSION_LTSC2019", @@ -9226,8 +9298,8 @@ ], "enumDescriptions": [ "When OSVersion is not specified", - "LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base Image", - "LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base Image" + "LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base Image.", + "LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base Image." ], "type": "string" } diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index 4937a8e06c9..8eca63f7f64 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -220,6 +220,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.europe-west10.rep.googleapis.com/", "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1675,7 +1685,7 @@ } } }, - "revision": "20250307", + "revision": "20250425", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2913,7 +2923,7 @@ "type": "string" }, "path": { - "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "description": "Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", "type": "string" }, "repository": { diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index cf4b352c715..c1b0bf51861 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -220,6 +220,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.europe-west10.rep.googleapis.com/", "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1440,7 +1450,7 @@ } } }, - "revision": "20250307", + "revision": "20250425", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2484,7 +2494,7 @@ "type": "string" }, "path": { - "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "description": "Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", "type": "string" }, "repository": { @@ -6825,7 +6835,7 @@ "additionalProperties": { "type": "string" }, - "description": "\"\": \"\" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet", + "description": "\"\": \"\" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/v1/digest_set.md.", "type": "object" }, "name": { diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index b134c561257..fa33105b788 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -220,6 +220,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.europe-west10.rep.googleapis.com/", "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1731,7 +1741,7 @@ } } }, - "revision": "20250307", + "revision": "20250425", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2849,7 +2859,7 @@ "type": "string" }, "path": { - "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "description": "Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", "type": "string" }, "repository": { diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index 7abc3f12626..6d62ad75935 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -2294,7 +2294,7 @@ ] }, "setinventoryverificationcontact": { - "description": "Sets the inventory verification contract for the specified country.", + "description": "Sets the inventory verification contact for the specified country.", "flatPath": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact", "httpMethod": "POST", "id": "content.liasettings.setinventoryverificationcontact", @@ -4570,7 +4570,7 @@ } } }, - "revision": "20250301", + "revision": "20250427", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -10077,7 +10077,7 @@ "type": "object" }, "Product": { - "description": " Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.", + "description": " Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.", "id": "Product", "properties": { "additionalImageLinks": { diff --git a/discovery/css-v1.json b/discovery/css-v1.json index 51289d93dd8..0f01eec0283 100644 --- a/discovery/css-v1.json +++ b/discovery/css-v1.json @@ -292,7 +292,7 @@ ], "parameters": { "name": { - "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", + "description": "Identifier. 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, @@ -484,7 +484,7 @@ ], "parameters": { "name": { - "description": "The resource name of the label. Format: accounts/{account}/labels/{label}", + "description": "Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}", "location": "path", "pattern": "^accounts/[^/]+/labels/[^/]+$", "required": true, @@ -503,11 +503,51 @@ ] } } + }, + "quotas": { + "methods": { + "list": { + "description": "Lists the daily call quota and usage per group for your CSS Center account.", + "flatPath": "v1/accounts/{accountsId}/quotas", + "httpMethod": "GET", + "id": "css.accounts.quotas.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The CSS account that owns the collection of method quotas and resources. In most cases, this is the CSS domain. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/quotas", + "response": { + "$ref": "ListQuotaGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } } } } }, - "revision": "20250219", + "revision": "20250421", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -622,7 +662,7 @@ "type": "string" }, "name": { - "description": "The resource name of the label. Format: accounts/{account}/labels/{label}", + "description": "Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}", "type": "string" } }, @@ -960,7 +1000,7 @@ "type": "string" }, "name": { - "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", + "description": "Identifier. 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": { @@ -1216,6 +1256,51 @@ }, "type": "object" }, + "ListQuotaGroupsResponse": { + "description": "Response message for the ListMethodGroups method.", + "id": "ListQuotaGroupsResponse", + "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" + }, + "quotaGroups": { + "description": "The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quota_usage.", + "items": { + "$ref": "QuotaGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "MethodDetails": { + "description": "The method details per method in the CSS API.", + "id": "MethodDetails", + "properties": { + "method": { + "description": "Output only. The name of the method for example `cssproductsservice.listcssproducts`.", + "readOnly": true, + "type": "string" + }, + "path": { + "description": "Output only. The path for the method such as `v1/cssproductsservice.listcssproducts`.", + "readOnly": true, + "type": "string" + }, + "subapi": { + "description": "Output only. The sub-API that the method belongs to. In the CSS API, this is always `css`.", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Output only. The API version that the method belongs to.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Price": { "description": "The price represented as a number and currency.", "id": "Price", @@ -1283,6 +1368,43 @@ }, "type": "object" }, + "QuotaGroup": { + "description": "The group information for methods in the CSS API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned.", + "id": "QuotaGroup", + "properties": { + "methodDetails": { + "description": "Output only. List of all methods group quota applies to.", + "items": { + "$ref": "MethodDetails" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Identifier. The resource name of the quota group. Format: accounts/{account}/quotas/{group} Example: `accounts/12345678/quotas/css-products-insert` Note: The {group} part is not guaranteed to follow a specific pattern.", + "type": "string" + }, + "quotaLimit": { + "description": "Output only. The maximum number of calls allowed per day for the group.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "quotaMinuteLimit": { + "description": "Output only. The maximum number of calls allowed per minute for the group.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "quotaUsage": { + "description": "Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "UpdateAccountLabelsRequest": { "description": "The request message for the `UpdateLabels` method.", "id": "UpdateAccountLabelsRequest", diff --git a/discovery/datacatalog-v1.json b/discovery/datacatalog-v1.json index 01cd0e673f6..91ba10d8908 100644 --- a/discovery/datacatalog-v1.json +++ b/discovery/datacatalog-v1.json @@ -161,7 +161,7 @@ "type": "string" }, "sqlResource": { - "description": "The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}` * `pubsub.topic.{PROJECT_ID}.`\\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\\` * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}` * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}` * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}` Identifiers (`*_ID`) should comply with the [Lexical structure in Standard SQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).", + "description": "The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}` * `pubsub.topic.{PROJECT_ID}.`\\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\\` * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}` * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}` * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}` Identifiers (`*_ID`) should comply with the [Lexical structure in GoogleSQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).", "location": "query", "type": "string" } @@ -2339,7 +2339,7 @@ } } }, - "revision": "20250212", + "revision": "20250411", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -3641,6 +3641,11 @@ "Migration of Tag Templates from Data Catalog to Dataplex is disabled." ], "type": "string" + }, + "templateMigrationEnabledTime": { + "description": "The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set.", + "format": "google-datetime", + "type": "string" } }, "type": "object" diff --git a/discovery/datacatalog-v1beta1.json b/discovery/datacatalog-v1beta1.json index 5fc8552dadf..fc63d84a9c6 100644 --- a/discovery/datacatalog-v1beta1.json +++ b/discovery/datacatalog-v1beta1.json @@ -146,7 +146,7 @@ "type": "string" }, "sqlResource": { - "description": "The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s should satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.", + "description": "The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s should satisfy the GoogleSQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.", "location": "query", "type": "string" } @@ -1855,7 +1855,7 @@ } } }, - "revision": "20250212", + "revision": "20250314", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index d9611701d18..a95ba43dbef 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -2208,7 +2208,7 @@ } } }, - "revision": "20250310", + "revision": "20250421", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -4763,6 +4763,10 @@ "description": "Describes the state of a metric.", "id": "MetricUpdate", "properties": { + "boundedTrie": { + "description": "Worker-computed aggregate value for the \"Trie\" aggregation kind. The only possible value type is a BoundedTrieNode. Introduced this field to avoid breaking older SDKs when Dataflow service starts to populate the `bounded_trie` field.", + "type": "any" + }, "cumulative": { "description": "True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.", "type": "boolean" diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index 451c423e595..a597503a515 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -172,6 +172,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -206,7 +212,7 @@ ] }, "updateConfig": { - "description": "Update default config for a given project and location. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields", + "description": "Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/config", "httpMethod": "PATCH", "id": "dataform.projects.locations.updateConfig", @@ -486,7 +492,7 @@ ] }, "list": { - "description": "Lists Repositories in a given project and location.", + "description": "Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories", "httpMethod": "GET", "id": "dataform.projects.locations.repositories.list", @@ -533,7 +539,7 @@ ] }, "patch": { - "description": "Updates a single Repository. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields", + "description": "Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", "httpMethod": "PATCH", "id": "dataform.projects.locations.repositories.patch", @@ -984,7 +990,7 @@ ] }, "patch": { - "description": "Updates a single ReleaseConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields", + "description": "Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}", "httpMethod": "PATCH", "id": "dataform.projects.locations.repositories.releaseConfigs.patch", @@ -1146,7 +1152,7 @@ ] }, "patch": { - "description": "Updates a single WorkflowConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields", + "description": "Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}", "httpMethod": "PATCH", "id": "dataform.projects.locations.repositories.workflowConfigs.patch", @@ -2141,9 +2147,84 @@ } } }, - "revision": "20250306", + "revision": "20250420", "rootUrl": "https://dataform.googleapis.com/", "schemas": { + "ActionErrorTable": { + "description": "Error table information, used to write error data into a BigQuery table.", + "id": "ActionErrorTable", + "properties": { + "retentionDays": { + "description": "Error table partition expiration in days. Only positive values are allowed.", + "format": "int32", + "type": "integer" + }, + "target": { + "$ref": "Target", + "description": "Error Table target." + } + }, + "type": "object" + }, + "ActionIncrementalLoadMode": { + "description": "Load definition for incremental load modes", + "id": "ActionIncrementalLoadMode", + "properties": { + "column": { + "description": "Column name for incremental load modes", + "type": "string" + } + }, + "type": "object" + }, + "ActionLoadConfig": { + "description": "Simplified load configuration for actions", + "id": "ActionLoadConfig", + "properties": { + "append": { + "$ref": "ActionSimpleLoadMode", + "description": "Append into destination table" + }, + "maximum": { + "$ref": "ActionIncrementalLoadMode", + "description": "Insert records where the value exceeds the previous maximum value for a column in the destination table" + }, + "replace": { + "$ref": "ActionSimpleLoadMode", + "description": "Replace destination table" + }, + "unique": { + "$ref": "ActionIncrementalLoadMode", + "description": "Insert records where the value of a column is not already present in the destination table" + } + }, + "type": "object" + }, + "ActionSimpleLoadMode": { + "description": "Simple load definition", + "id": "ActionSimpleLoadMode", + "properties": {}, + "type": "object" + }, + "ActionSqlDefinition": { + "description": "Definition of a SQL Data Preparation", + "id": "ActionSqlDefinition", + "properties": { + "errorTable": { + "$ref": "ActionErrorTable", + "description": "Error table configuration," + }, + "loadConfig": { + "$ref": "ActionLoadConfig", + "description": "Load configuration." + }, + "query": { + "description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.", + "type": "string" + } + }, + "type": "object" + }, "Assertion": { "description": "Represents an assertion upon a SQL query which is required return zero rows.", "id": "Assertion", @@ -2240,6 +2321,10 @@ "description": "Optional. The default schema (BigQuery dataset ID) for assertions.", "type": "string" }, + "builtinAssertionNamePrefix": { + "description": "Optional. The prefix to prepend to built-in assertion names.", + "type": "string" + }, "databaseSuffix": { "description": "Optional. The suffix that should be appended to all database (Google Cloud project ID) names.", "type": "string" @@ -2519,6 +2604,10 @@ "$ref": "Target", "description": "The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result." }, + "dataPreparation": { + "$ref": "DataPreparation", + "description": "The data preparation executed by this action." + }, "declaration": { "$ref": "Declaration", "description": "The declaration declared by this action." @@ -2600,6 +2689,65 @@ }, "type": "object" }, + "DataPreparation": { + "description": "Defines a compiled Data Preparation entity", + "id": "DataPreparation", + "properties": { + "contentsSql": { + "$ref": "SqlDefinition", + "description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information." + }, + "contentsYaml": { + "description": "The data preparation definition, stored as a YAML string.", + "type": "string" + }, + "dependencyTargets": { + "description": "A list of actions that this action depends on.", + "items": { + "$ref": "Target" + }, + "type": "array" + }, + "disabled": { + "description": "Whether this action is disabled (i.e. should not be run).", + "type": "boolean" + }, + "tags": { + "description": "Arbitrary, user-defined tags on this action.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DataPreparationAction": { + "description": "Represents a workflow action that will run a Data Preparation.", + "id": "DataPreparationAction", + "properties": { + "contentsSql": { + "$ref": "ActionSqlDefinition", + "description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information." + }, + "contentsYaml": { + "description": "Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.", + "readOnly": true, + "type": "string" + }, + "generatedSql": { + "description": "Output only. The generated BigQuery SQL script that will be executed. For reference only.", + "readOnly": true, + "type": "string" + }, + "jobId": { + "description": "Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Declaration": { "description": "Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.", "id": "Declaration", @@ -2649,6 +2797,22 @@ "properties": {}, "type": "object" }, + "ErrorTable": { + "description": "Error table information, used to write error data into a BigQuery table.", + "id": "ErrorTable", + "properties": { + "retentionDays": { + "description": "Error table partition expiration in days. Only positive values are allowed.", + "format": "int32", + "type": "integer" + }, + "target": { + "$ref": "Target", + "description": "Error Table target." + } + }, + "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", @@ -2813,6 +2977,17 @@ }, "type": "object" }, + "IncrementalLoadMode": { + "description": "Load definition for incremental load modes", + "id": "IncrementalLoadMode", + "properties": { + "column": { + "description": "Column name for incremental load modes", + "type": "string" + } + }, + "type": "object" + }, "IncrementalTableConfig": { "description": "Contains settings for relations of type `INCREMENTAL_TABLE`.", "id": "IncrementalTableConfig", @@ -3087,6 +3262,29 @@ }, "type": "object" }, + "LoadConfig": { + "description": "Simplified load configuration for actions", + "id": "LoadConfig", + "properties": { + "append": { + "$ref": "SimpleLoadMode", + "description": "Append into destination table" + }, + "maximum": { + "$ref": "IncrementalLoadMode", + "description": "Insert records where the value exceeds the previous maximum value for a column in the destination table" + }, + "replace": { + "$ref": "SimpleLoadMode", + "description": "Replace destination table" + }, + "unique": { + "$ref": "IncrementalLoadMode", + "description": "Insert records where the value of a column is not already present in the destination table" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -3854,6 +4052,31 @@ }, "type": "object" }, + "SimpleLoadMode": { + "description": "Simple load definition", + "id": "SimpleLoadMode", + "properties": {}, + "type": "object" + }, + "SqlDefinition": { + "description": "Definition of a SQL Data Preparation", + "id": "SqlDefinition", + "properties": { + "errorTable": { + "$ref": "ErrorTable", + "description": "Error table configuration," + }, + "load": { + "$ref": "LoadConfig", + "description": "Load configuration." + }, + "query": { + "description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.", + "type": "string" + } + }, + "type": "object" + }, "SshAuthenticationConfig": { "description": "Configures fields for performing SSH authentication.", "id": "SshAuthenticationConfig", @@ -3987,6 +4210,10 @@ "description": "Optional. Optional schedule (in cron format) for automatic execution of this workflow config.", "type": "string" }, + "disabled": { + "description": "Optional. Disables automatic creation of workflow invocations.", + "type": "boolean" + }, "internalMetadata": { "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", "readOnly": true, @@ -4104,6 +4331,11 @@ "description": "Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.", "readOnly": true }, + "dataPreparationAction": { + "$ref": "DataPreparationAction", + "description": "Output only. The workflow action's data preparation action details.", + "readOnly": true + }, "failureReason": { "description": "Output only. If and only if action's state is FAILED a failure reason is set.", "readOnly": true, diff --git a/discovery/datafusion-v1.json b/discovery/datafusion-v1.json index 5140c3e13c1..4f35cd2347f 100644 --- a/discovery/datafusion-v1.json +++ b/discovery/datafusion-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -732,7 +738,7 @@ } } }, - "revision": "20250224", + "revision": "20250414", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1137,6 +1143,13 @@ "readOnly": true, "type": "string" }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "type": "object" + }, "tenantProjectId": { "description": "Output only. The name of the tenant project.", "readOnly": true, diff --git a/discovery/datafusion-v1beta1.json b/discovery/datafusion-v1beta1.json index 9c59190257e..cc8364fdee5 100644 --- a/discovery/datafusion-v1beta1.json +++ b/discovery/datafusion-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -930,7 +936,7 @@ } } }, - "revision": "20250224", + "revision": "20250414", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1349,6 +1355,13 @@ "readOnly": true, "type": "string" }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "type": "object" + }, "tenantProjectId": { "description": "Output only. The name of the tenant project.", "readOnly": true, diff --git a/discovery/datalineage-v1.json b/discovery/datalineage-v1.json index 974be1416de..0e50d0293d9 100644 --- a/discovery/datalineage-v1.json +++ b/discovery/datalineage-v1.json @@ -66,6 +66,11 @@ "endpointUrl": "https://datalineage.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datalineage.asia-southeast3.rep.googleapis.com/", + "location": "asia-southeast3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://datalineage.australia-southeast1.rep.googleapis.com/", @@ -1040,7 +1045,7 @@ } } }, - "revision": "20250207", + "revision": "20250319", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index ea3c40d69c6..ec60a5b0889 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -179,6 +179,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2334,7 +2340,7 @@ } } }, - "revision": "20250226", + "revision": "20250416", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -4591,6 +4597,10 @@ "description": "The number of CPU's in the VM instance.", "format": "int32", "type": "integer" + }, + "machineType": { + "description": "Optional. 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" @@ -4931,6 +4941,10 @@ "$ref": "SqlServerHomogeneousMigrationJobConfig", "description": "Optional. Configuration for SQL Server homogeneous migration." }, + "sqlserverToPostgresConfig": { + "$ref": "SqlServerToPostgresConfig", + "description": "Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations." + }, "state": { "description": "The current migration job state.", "enum": [ @@ -6215,15 +6229,27 @@ "description": "Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.", "type": "string" }, + "schema": { + "description": "Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.", + "type": "string" + }, + "table": { + "description": "Optional. The table name. This will be required only if the object is a level below database or schema.", + "type": "string" + }, "type": { "description": "Required. The type of the migration job object.", "enum": [ "MIGRATION_JOB_OBJECT_TYPE_UNSPECIFIED", - "DATABASE" + "DATABASE", + "SCHEMA", + "TABLE" ], "enumDescriptions": [ "The type of the migration job object is unknown.", - "The migration job object is a database." + "The migration job object is a database.", + "The migration job object is a schema.", + "The migration job object is a table." ], "type": "string" } @@ -6368,6 +6394,10 @@ "description": "If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.", "type": "string" }, + "database": { + "description": "Required. The name of the specific database within the host.", + "type": "string" + }, "forwardSshConnectivity": { "$ref": "ForwardSshTunnelConnectivity", "description": "Forward SSH tunnel connectivity." @@ -6473,6 +6503,46 @@ }, "type": "object" }, + "SqlServerSourceConfig": { + "description": "Configuration for SQL Server as a source in a migration.", + "id": "SqlServerSourceConfig", + "properties": { + "cdcStartPosition": { + "description": "Optional. The log sequence number (LSN) to start CDC data migration from.", + "type": "string" + }, + "maxConcurrentCdcConnections": { + "description": "Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.", + "format": "int32", + "type": "integer" + }, + "maxConcurrentFullDumpConnections": { + "description": "Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.", + "format": "int32", + "type": "integer" + }, + "skipFullDump": { + "description": "Optional. Whether to skip full dump or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "SqlServerToPostgresConfig": { + "description": "Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations.", + "id": "SqlServerToPostgresConfig", + "properties": { + "postgresDestinationConfig": { + "$ref": "PostgresDestinationConfig", + "description": "Optional. Configuration for Postgres destination." + }, + "sqlserverSourceConfig": { + "$ref": "SqlServerSourceConfig", + "description": "Optional. Configuration for SQL Server source." + } + }, + "type": "object" + }, "SshScript": { "description": "Response message for 'GenerateSshScript' request.", "id": "SshScript", diff --git a/discovery/datamigration-v1beta1.json b/discovery/datamigration-v1beta1.json index 7dedf0ebeb3..e95136072d8 100644 --- a/discovery/datamigration-v1beta1.json +++ b/discovery/datamigration-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1049,7 +1055,7 @@ } } }, - "revision": "20241202", + "revision": "20250409", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 918affb7e47..1296dd964b5 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -348,6 +348,94 @@ "resources": { "encryptionConfigs": { "methods": { + "create": { + "description": "Create an EncryptionConfig.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs", + "httpMethod": "POST", + "id": "dataplex.organizations.locations.encryptionConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "encryptionConfigId": { + "description": "Required. The ID of the EncryptionConfig to create. Currently, only a value of \"default\" is supported.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location at which the EncryptionConfig is to be created.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/encryptionConfigs", + "request": { + "$ref": "GoogleCloudDataplexV1EncryptionConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an EncryptionConfig.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}", + "httpMethod": "DELETE", + "id": "dataplex.organizations.locations.encryptionConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. Etag of the EncryptionConfig. This is a strong etag.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the EncryptionConfig to delete.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get an EncryptionConfig.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}", + "httpMethod": "GET", + "id": "dataplex.organizations.locations.encryptionConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EncryptionConfig to fetch.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1EncryptionConfig" + }, + "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/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:getIamPolicy", @@ -379,6 +467,86 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "List EncryptionConfigs.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs", + "httpMethod": "GET", + "id": "dataplex.organizations.locations.encryptionConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter the EncryptionConfigs to be returned. Using bare literals: (These values will be matched anywhere it may appear in the object's field values) * filter=some_value Using fields: (These values will be matched only in the specified field) * filter=some_field=some_value Supported fields: * name, key, create_time, update_time, encryption_state Example: * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config conjunctions: (AND, OR, NOT) * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (>, <, >=, <=, !=, =, :), * filter=create_time>2024-05-01T00:00:00.000Z", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of EncryptionConfigs to return. The service may return fewer than this value. If unspecified, at most 10 EncryptionConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous ListEncryptionConfigs call. Provide this to retrieve the subsequent page. When paginating, the parameters - filter and order_by provided to ListEncryptionConfigs must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location for which the EncryptionConfig is to be listed.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/encryptionConfigs", + "response": { + "$ref": "GoogleCloudDataplexV1ListEncryptionConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update an EncryptionConfig.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}", + "httpMethod": "PATCH", + "id": "dataplex.organizations.locations.encryptionConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask of fields to update. The service treats an omitted field mask as an implied field mask equivalent to all fields that are populated (have a non-empty value).", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDataplexV1EncryptionConfig" + }, + "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/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:setIamPolicy", @@ -602,6 +770,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -6257,7 +6431,7 @@ } } }, - "revision": "20250307", + "revision": "20250419", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -6860,7 +7034,7 @@ "description": "Optional. Configuration for Json data." }, "schedule": { - "description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.", + "description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes.To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.", "type": "string" } }, @@ -7431,6 +7605,11 @@ "$ref": "GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing", "description": "Output only. Configuration for metadata publishing.", "readOnly": true + }, + "scanStatistics": { + "$ref": "GoogleCloudDataplexV1DataDiscoveryResultScanStatistics", + "description": "Output only. Describes result statistics of a data scan discovery job.", + "readOnly": true } }, "type": "object" @@ -7443,6 +7622,63 @@ "description": "Output only. The BigQuery dataset the discovered tables are published to.", "readOnly": true, "type": "string" + }, + "location": { + "description": "Output only. The location of the BigQuery publishing dataset.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DataDiscoveryResultScanStatistics": { + "description": "Describes result statistics of a data scan discovery job.", + "id": "GoogleCloudDataplexV1DataDiscoveryResultScanStatistics", + "properties": { + "dataProcessedBytes": { + "description": "The data processed in bytes.", + "format": "int64", + "type": "string" + }, + "filesExcluded": { + "description": "The number of files excluded.", + "format": "int32", + "type": "integer" + }, + "filesetsCreated": { + "description": "The number of filesets created.", + "format": "int32", + "type": "integer" + }, + "filesetsDeleted": { + "description": "The number of filesets deleted.", + "format": "int32", + "type": "integer" + }, + "filesetsUpdated": { + "description": "The number of filesets updated.", + "format": "int32", + "type": "integer" + }, + "scannedFileCount": { + "description": "The number of files scanned.", + "format": "int32", + "type": "integer" + }, + "tablesCreated": { + "description": "The number of tables created.", + "format": "int32", + "type": "integer" + }, + "tablesDeleted": { + "description": "The number of tables deleted.", + "format": "int32", + "type": "integer" + }, + "tablesUpdated": { + "description": "The number of tables updated.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -7859,7 +8095,7 @@ "id": "GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport", "properties": { "resultsTable": { - "description": "Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", + "description": "Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", "type": "string" } }, @@ -7902,7 +8138,7 @@ "id": "GoogleCloudDataplexV1DataQualityDimension", "properties": { "name": { - "description": "The dimension name a rule belongs to. Supported dimensions are \"COMPLETENESS\", \"ACCURACY\", \"CONSISTENCY\", \"VALIDITY\", \"UNIQUENESS\", \"FRESHNESS\", \"VOLUME\"", + "description": "Optional. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.", "type": "string" } }, @@ -7918,7 +8154,8 @@ "readOnly": true }, "passed": { - "description": "Whether the dimension passed or failed.", + "description": "Output only. Whether the dimension passed or failed.", + "readOnly": true, "type": "boolean" }, "score": { @@ -7943,14 +8180,16 @@ "type": "array" }, "dimensions": { - "description": "A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.", + "description": "Output only. A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.", "items": { "$ref": "GoogleCloudDataplexV1DataQualityDimensionResult" }, + "readOnly": true, "type": "array" }, "passed": { - "description": "Overall data quality result -- true if all rules passed.", + "description": "Output only. Overall data quality result -- true if all rules passed.", + "readOnly": true, "type": "boolean" }, "postScanActionsResult": { @@ -7959,20 +8198,23 @@ "readOnly": true }, "rowCount": { - "description": "The count of rows processed.", + "description": "Output only. The count of rows processed.", "format": "int64", + "readOnly": true, "type": "string" }, "rules": { - "description": "A list of all the rules in a job, and their results.", + "description": "Output only. A list of all the rules in a job, and their results.", "items": { "$ref": "GoogleCloudDataplexV1DataQualityRuleResult" }, + "readOnly": true, "type": "array" }, "scannedData": { "$ref": "GoogleCloudDataplexV1ScannedData", - "description": "The data scanned for this result." + "description": "Output only. The data scanned for this result.", + "readOnly": true }, "score": { "description": "Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).", @@ -8147,36 +8389,43 @@ "type": "string" }, "evaluatedCount": { - "description": "The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion.", + "description": "Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion.", "format": "int64", + "readOnly": true, "type": "string" }, "failingRowsQuery": { - "description": "The query to find rows that did not pass this rule.This field is only valid for row-level type rules.", + "description": "Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules.", + "readOnly": true, "type": "string" }, "nullCount": { - "description": "The number of rows with null values in the specified column.", + "description": "Output only. The number of rows with null values in the specified column.", "format": "int64", + "readOnly": true, "type": "string" }, "passRatio": { - "description": "The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules.", + "description": "Output only. The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules.", "format": "double", + "readOnly": true, "type": "number" }, "passed": { - "description": "Whether the rule passed or failed.", + "description": "Output only. Whether the rule passed or failed.", + "readOnly": true, "type": "boolean" }, "passedCount": { - "description": "This field is not set for rule SqlAssertion.", + "description": "Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion.", "format": "int64", + "readOnly": true, "type": "string" }, "rule": { "$ref": "GoogleCloudDataplexV1DataQualityRule", - "description": "The rule specified in the DataQualitySpec, as is." + "description": "Output only. The rule specified in the DataQualitySpec, as is.", + "readOnly": true } }, "type": "object" @@ -8428,7 +8677,7 @@ "id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport", "properties": { "resultsTable": { - "description": "Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", + "description": "Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID", "type": "string" } }, @@ -9290,6 +9539,86 @@ }, "type": "object" }, + "GoogleCloudDataplexV1EncryptionConfig": { + "description": "A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK).", + "id": "GoogleCloudDataplexV1EncryptionConfig", + "properties": { + "createTime": { + "description": "Output only. The time when the Encryption configuration was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "encryptionState": { + "description": "Output only. The state of encryption of the databases.", + "enum": [ + "ENCRYPTION_STATE_UNSPECIFIED", + "ENCRYPTING", + "COMPLETED", + "FAILED" + ], + "enumDescriptions": [ + "State is not specified.", + "The encryption state of the database when the EncryptionConfig is created or updated. If the encryption fails, it is retried indefinitely and the state is shown as ENCRYPTING.", + "The encryption of data has completed successfully.", + "The encryption of data has failed. The state is set to FAILED when the encryption fails due to reasons like permission issues, invalid key etc." + ], + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Etag of the EncryptionConfig. This is a strong etag.", + "type": "string" + }, + "failureDetails": { + "$ref": "GoogleCloudDataplexV1EncryptionConfigFailureDetails", + "description": "Output only. Details of the failure if anything related to Cmek db fails.", + "readOnly": true + }, + "key": { + "description": "Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the Encryption configuration was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1EncryptionConfigFailureDetails": { + "description": "Details of the failure if anything related to Cmek db fails.", + "id": "GoogleCloudDataplexV1EncryptionConfigFailureDetails", + "properties": { + "errorCode": { + "description": "Output only. The error code for the failure.", + "enum": [ + "UNKNOWN", + "INTERNAL_ERROR", + "REQUIRE_USER_ACTION" + ], + "enumDescriptions": [ + "The error code is not specified", + "Error because of internal server error, will be retried automatically.", + "User action is required to resolve the error." + ], + "readOnly": true, + "type": "string" + }, + "errorMessage": { + "description": "Output only. The error message will be shown to the user. Set only if the error code is REQUIRE_USER_ACTION.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Entity": { "description": "Represents tables and fileset metadata contained within a zone.", "id": "GoogleCloudDataplexV1Entity", @@ -9541,6 +9870,35 @@ }, "type": "object" }, + "GoogleCloudDataplexV1EntryLinkEvent": { + "description": "Payload associated with Entry related log events.", + "id": "GoogleCloudDataplexV1EntryLinkEvent", + "properties": { + "eventType": { + "description": "The type of the event.", + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "ENTRY_LINK_CREATE", + "ENTRY_LINK_DELETE" + ], + "enumDescriptions": [ + "An unspecified event type.", + "EntryLink create event.", + "EntryLink delete event." + ], + "type": "string" + }, + "message": { + "description": "The log message.", + "type": "string" + }, + "resource": { + "description": "Name of the resource.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1EntrySource": { "description": "Information related to the source system of the data resource that is represented by the entry.", "id": "GoogleCloudDataplexV1EntrySource", @@ -10556,6 +10914,31 @@ }, "type": "object" }, + "GoogleCloudDataplexV1ListEncryptionConfigsResponse": { + "description": "List EncryptionConfigs Response", + "id": "GoogleCloudDataplexV1ListEncryptionConfigsResponse", + "properties": { + "encryptionConfigs": { + "description": "The list of EncryptionConfigs under the given parent location.", + "items": { + "$ref": "GoogleCloudDataplexV1EncryptionConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1ListEntitiesResponse": { "description": "List metadata entities response.", "id": "GoogleCloudDataplexV1ListEntitiesResponse", @@ -10817,6 +11200,15 @@ "readOnly": true, "type": "string" }, + "exportResult": { + "$ref": "GoogleCloudDataplexV1MetadataJobExportJobResult", + "description": "Output only. Export job result.", + "readOnly": true + }, + "exportSpec": { + "$ref": "GoogleCloudDataplexV1MetadataJobExportJobSpec", + "description": "Export job specification." + }, "importResult": { "$ref": "GoogleCloudDataplexV1MetadataJobImportJobResult", "description": "Output only. Import job result.", @@ -10847,11 +11239,13 @@ "description": "Required. Metadata job type.", "enum": [ "TYPE_UNSPECIFIED", - "IMPORT" + "IMPORT", + "EXPORT" ], "enumDescriptions": [ "Unspecified.", - "Import job." + "Import job.", + "Export job." ], "type": "string" }, @@ -10869,6 +11263,78 @@ }, "type": "object" }, + "GoogleCloudDataplexV1MetadataJobExportJobResult": { + "description": "Summary results from a metadata export job. The results are a snapshot of the metadata at the time when the job was created. The exported entries are saved to a Cloud Storage bucket.", + "id": "GoogleCloudDataplexV1MetadataJobExportJobResult", + "properties": { + "errorMessage": { + "description": "Output only. The error message if the metadata export job failed.", + "readOnly": true, + "type": "string" + }, + "exportedEntries": { + "description": "Output only. The number of entries that were exported.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1MetadataJobExportJobSpec": { + "description": "Job specification for a metadata export job.", + "id": "GoogleCloudDataplexV1MetadataJobExportJobSpec", + "properties": { + "outputPath": { + "description": "Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.The bucket must be in the same VPC Service Controls perimeter as the job.", + "type": "string" + }, + "scope": { + "$ref": "GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope", + "description": "Required. The scope of the export job." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope": { + "description": "The scope of the export job.", + "id": "GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope", + "properties": { + "aspectTypes": { + "description": "The aspect types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. Only aspects that belong to the specified aspect types are affected by the job.", + "items": { + "type": "string" + }, + "type": "array" + }, + "entryGroups": { + "description": "The entry groups whose metadata you want to export, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. Only the entries in the specified entry groups are exported.The entry groups must be in the same location and the same VPC Service Controls perimeter as the job.If you set the job scope to be a list of entry groups, then set the organization-level export flag to false and don't provide a list of projects.", + "items": { + "type": "string" + }, + "type": "array" + }, + "entryTypes": { + "description": "The entry types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are affected by the job.", + "items": { + "type": "string" + }, + "type": "array" + }, + "organizationLevel": { + "description": "Whether the metadata export job is an organization-level export job. If true, the job exports the entries from the same organization and VPC Service Controls perimeter as the job. The project that the job belongs to determines the VPC Service Controls perimeter. If you set the job scope to be at the organization level, then don't provide a list of projects or entry groups. If false, you must specify a list of projects or a list of entry groups whose entries you want to export.The default is false.", + "type": "boolean" + }, + "projects": { + "description": "The projects whose metadata you want to export, in the format projects/{project_id_or_number}. Only the entries from the specified projects are exported.The projects must be in the same organization and VPC Service Controls perimeter as the job.If you set the job scope to be a list of projects, then set the organization-level export flag to false and don't provide a list of entry groups.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1MetadataJobImportJobResult": { "description": "Results from a metadata import job.", "id": "GoogleCloudDataplexV1MetadataJobImportJobResult", @@ -10972,7 +11438,7 @@ "type": "string" }, "sourceStorageUri": { - "description": "Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.", + "description": "Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata import job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.", "type": "string" } }, @@ -12229,7 +12695,7 @@ "description": "Optional. Configuration for Json data." }, "schedule": { - "description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.", + "description": "Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes.To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.", "type": "string" } }, diff --git a/discovery/datastream-v1.json b/discovery/datastream-v1.json index fbb88450309..6d7272ae212 100644 --- a/discovery/datastream-v1.json +++ b/discovery/datastream-v1.json @@ -179,6 +179,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -598,6 +604,11 @@ "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 will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" + }, + "validateOnly": { + "description": "Optional. When supplied with PSC Interface config, will get/create the tenant project required for the customer to allow list and won't actually create the private connection.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/privateConnections", @@ -1250,7 +1261,7 @@ } } }, - "revision": "20250310", + "revision": "20250321", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1269,6 +1280,10 @@ "description": "Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded.", "id": "BackfillAllStrategy", "properties": { + "mongodbExcludedObjects": { + "$ref": "MongodbCluster", + "description": "MongoDB data source objects to avoid backfilling" + }, "mysqlExcludedObjects": { "$ref": "MysqlRdbms", "description": "MySQL data source objects to avoid backfilling." @@ -1524,6 +1539,10 @@ "description": "Labels.", "type": "object" }, + "mongodbProfile": { + "$ref": "MongodbProfile", + "description": "MongoDB Connection Profile configuration." + }, "mysqlProfile": { "$ref": "MysqlProfile", "description": "MySQL ConnectionProfile configuration." @@ -1635,6 +1654,10 @@ "format": "int32", "type": "integer" }, + "mongodbCluster": { + "$ref": "MongodbCluster", + "description": "MongoDB cluster to enrich with child data objects and metadata." + }, "mysqlRdbms": { "$ref": "MysqlRdbms", "description": "MySQL RDBMS to enrich with child data objects and metadata." @@ -1647,6 +1670,10 @@ "$ref": "PostgresqlRdbms", "description": "PostgreSQL RDBMS to enrich with child data objects and metadata." }, + "salesforceOrg": { + "$ref": "SalesforceOrg", + "description": "Salesforce organization to enrich with child data objects and metadata." + }, "sqlServerRdbms": { "$ref": "SqlServerRdbms", "description": "SQLServer RDBMS to enrich with child data objects and metadata." @@ -1658,6 +1685,10 @@ "description": "Response from a discover request.", "id": "DiscoverConnectionProfileResponse", "properties": { + "mongodbCluster": { + "$ref": "MongodbCluster", + "description": "Enriched MongoDB cluster." + }, "mysqlRdbms": { "$ref": "MysqlRdbms", "description": "Enriched MySQL RDBMS object." @@ -1670,6 +1701,10 @@ "$ref": "PostgresqlRdbms", "description": "Enriched PostgreSQL RDBMS object." }, + "salesforceOrg": { + "$ref": "SalesforceOrg", + "description": "Enriched Salesforce organization." + }, "sqlServerRdbms": { "$ref": "SqlServerRdbms", "description": "Enriched SQLServer RDBMS object." @@ -1816,6 +1851,22 @@ "properties": {}, "type": "object" }, + "HostAddress": { + "description": "A HostAddress represents a transport end point, which is the combination of an IP address or hostname and a port number.", + "id": "HostAddress", + "properties": { + "hostname": { + "description": "Required. Hostname for the connection.", + "type": "string" + }, + "port": { + "description": "Optional. Port for the connection.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "JsonFileFormat": { "description": "JSON file format configuration.", "id": "JsonFileFormat", @@ -2077,6 +2128,135 @@ "properties": {}, "type": "object" }, + "MongodbCluster": { + "description": "MongoDB Cluster structure.", + "id": "MongodbCluster", + "properties": { + "databases": { + "description": "MongoDB databases in the cluster.", + "items": { + "$ref": "MongodbDatabase" + }, + "type": "array" + } + }, + "type": "object" + }, + "MongodbCollection": { + "description": "MongoDB Collection.", + "id": "MongodbCollection", + "properties": { + "collection": { + "description": "Collection name.", + "type": "string" + }, + "fields": { + "description": "Fields in the collection.", + "items": { + "$ref": "MongodbField" + }, + "type": "array" + } + }, + "type": "object" + }, + "MongodbDatabase": { + "description": "MongoDB Database.", + "id": "MongodbDatabase", + "properties": { + "collections": { + "description": "Collections in the database.", + "items": { + "$ref": "MongodbCollection" + }, + "type": "array" + }, + "database": { + "description": "Database name.", + "type": "string" + } + }, + "type": "object" + }, + "MongodbField": { + "description": "MongoDB Field.", + "id": "MongodbField", + "properties": { + "field": { + "description": "Field name.", + "type": "string" + } + }, + "type": "object" + }, + "MongodbObjectIdentifier": { + "description": "MongoDB data source object identifier.", + "id": "MongodbObjectIdentifier", + "properties": { + "collection": { + "description": "Required. The collection name.", + "type": "string" + }, + "database": { + "description": "Required. The database name.", + "type": "string" + } + }, + "type": "object" + }, + "MongodbProfile": { + "description": "MongoDB profile.", + "id": "MongodbProfile", + "properties": { + "hostAddresses": { + "description": "Required. List of host addresses for a MongoDB cluster.", + "items": { + "$ref": "HostAddress" + }, + "type": "array" + }, + "password": { + "description": "Optional. Password for the MongoDB connection. Mutually exclusive with the `secret_manager_stored_password` field.", + "type": "string" + }, + "replicaSet": { + "description": "Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster.", + "type": "string" + }, + "secretManagerStoredPassword": { + "description": "Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field.", + "type": "string" + }, + "srvConnectionFormat": { + "$ref": "SrvConnectionFormat", + "description": "Srv connection format." + }, + "standardConnectionFormat": { + "$ref": "StandardConnectionFormat", + "description": "Standard connection format." + }, + "username": { + "description": "Required. Username for the MongoDB connection.", + "type": "string" + } + }, + "type": "object" + }, + "MongodbSourceConfig": { + "description": "MongoDB source configuration.", + "id": "MongodbSourceConfig", + "properties": { + "excludeObjects": { + "$ref": "MongodbCluster", + "description": "MongoDB collections to exclude from the stream." + }, + "includeObjects": { + "$ref": "MongodbCluster", + "description": "MongoDB collections to include in the stream." + } + }, + "type": "object" + }, "MostRecentStartPosition": { "description": "CDC strategy to start replicating from the most recent position in the source.", "id": "MostRecentStartPosition", @@ -2925,6 +3105,10 @@ "readOnly": true, "type": "string" }, + "pscInterfaceConfig": { + "$ref": "PscInterfaceConfig", + "description": "PSC Interface Config." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -2980,6 +3164,17 @@ }, "type": "object" }, + "PscInterfaceConfig": { + "description": "The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer's PSC.", + "id": "PscInterfaceConfig", + "properties": { + "networkAttachment": { + "description": "Required. Fully qualified name of the Network Attachment that Datastream will connect to. Format: `projects/{{project}}/regions/{{region}}/networkAttachments/{{name}}`", + "type": "string" + } + }, + "type": "object" + }, "Route": { "description": "The route resource is the child of the private connection resource, used for defining a route for a private connection.", "id": "Route", @@ -3185,6 +3380,10 @@ "description": "The configuration of the stream source.", "id": "SourceConfig", "properties": { + "mongodbSourceConfig": { + "$ref": "MongodbSourceConfig", + "description": "MongoDB data source configuration." + }, "mysqlSourceConfig": { "$ref": "MysqlSourceConfig", "description": "MySQL data source configuration." @@ -3227,6 +3426,10 @@ "description": "Represents an identifier of an object in the data source.", "id": "SourceObjectIdentifier", "properties": { + "mongodbIdentifier": { + "$ref": "MongodbObjectIdentifier", + "description": "MongoDB data source object identifier." + }, "mysqlIdentifier": { "$ref": "MysqlObjectIdentifier", "description": "Mysql data source object identifier." @@ -3469,6 +3672,18 @@ "properties": {}, "type": "object" }, + "SrvConnectionFormat": { + "description": "Srv connection format.", + "id": "SrvConnectionFormat", + "properties": {}, + "type": "object" + }, + "StandardConnectionFormat": { + "description": "Standard connection format.", + "id": "StandardConnectionFormat", + "properties": {}, + "type": "object" + }, "StartBackfillJobRequest": { "description": "Request for manually initiating a backfill job for a specific stream object.", "id": "StartBackfillJobRequest", diff --git a/discovery/datastream-v1alpha1.json b/discovery/datastream-v1alpha1.json index 044c29c8cda..7ed5f9bb651 100644 --- a/discovery/datastream-v1alpha1.json +++ b/discovery/datastream-v1alpha1.json @@ -180,6 +180,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1224,7 +1230,7 @@ } } }, - "revision": "20241204", + "revision": "20250321", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { diff --git a/discovery/deploymentmanager-alpha.json b/discovery/deploymentmanager-alpha.json index d14cceea5e9..b392c7f9aa2 100644 --- a/discovery/deploymentmanager-alpha.json +++ b/discovery/deploymentmanager-alpha.json @@ -1676,7 +1676,7 @@ } } }, - "revision": "20250102", + "revision": "20250403", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2360,6 +2360,10 @@ "InstancesBulkInsertOperationMetadata": { "id": "InstancesBulkInsertOperationMetadata", "properties": { + "machineType": { + "description": "[Output Only] The machine type of the VMs that were created used internally only by KCP flex bulk insert.", + "type": "string" + }, "perLocationStatus": { "additionalProperties": { "$ref": "BulkInsertOperationStatus" @@ -2614,6 +2618,10 @@ "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" }, + "setAutoscalerLinkOperationMetadata": { + "$ref": "SetAutoscalerLinkOperationMetadata", + "description": "This field is used internally by the Autoscaler team and should not be promoted to \"alpha/beta/v1\"." + }, "setCommonInstanceMetadataOperationMetadata": { "$ref": "SetCommonInstanceMetadataOperationMetadata", "description": "[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state." @@ -3545,6 +3553,20 @@ }, "type": "object" }, + "SetAutoscalerLinkOperationMetadata": { + "id": "SetAutoscalerLinkOperationMetadata", + "properties": { + "zonalIgmIds": { + "description": "List of zonal IGM IDs part of the RMIG.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SetCommonInstanceMetadataOperationMetadata": { "id": "SetCommonInstanceMetadataOperationMetadata", "properties": { diff --git a/discovery/deploymentmanager-v2.json b/discovery/deploymentmanager-v2.json index 367a4b0056e..83941b94561 100644 --- a/discovery/deploymentmanager-v2.json +++ b/discovery/deploymentmanager-v2.json @@ -1028,7 +1028,7 @@ } } }, - "revision": "20250102", + "revision": "20250403", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1437,6 +1437,10 @@ "InstancesBulkInsertOperationMetadata": { "id": "InstancesBulkInsertOperationMetadata", "properties": { + "machineType": { + "description": "[Output Only] The machine type of the VMs that were created used internally only by KCP flex bulk insert.", + "type": "string" + }, "perLocationStatus": { "additionalProperties": { "$ref": "BulkInsertOperationStatus" @@ -1664,6 +1668,10 @@ "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" }, + "setAutoscalerLinkOperationMetadata": { + "$ref": "SetAutoscalerLinkOperationMetadata", + "description": "This field is used internally by the Autoscaler team and should not be promoted to \"alpha/beta/v1\"." + }, "setCommonInstanceMetadataOperationMetadata": { "$ref": "SetCommonInstanceMetadataOperationMetadata", "description": "[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state." @@ -2480,6 +2488,20 @@ }, "type": "object" }, + "SetAutoscalerLinkOperationMetadata": { + "id": "SetAutoscalerLinkOperationMetadata", + "properties": { + "zonalIgmIds": { + "description": "List of zonal IGM IDs part of the RMIG.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SetCommonInstanceMetadataOperationMetadata": { "id": "SetCommonInstanceMetadataOperationMetadata", "properties": { diff --git a/discovery/deploymentmanager-v2beta.json b/discovery/deploymentmanager-v2beta.json index 226166cf713..063cd62f6b5 100644 --- a/discovery/deploymentmanager-v2beta.json +++ b/discovery/deploymentmanager-v2beta.json @@ -1636,7 +1636,7 @@ } } }, - "revision": "20250102", + "revision": "20250403", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2286,6 +2286,10 @@ "InstancesBulkInsertOperationMetadata": { "id": "InstancesBulkInsertOperationMetadata", "properties": { + "machineType": { + "description": "[Output Only] The machine type of the VMs that were created used internally only by KCP flex bulk insert.", + "type": "string" + }, "perLocationStatus": { "additionalProperties": { "$ref": "BulkInsertOperationStatus" @@ -2513,6 +2517,10 @@ "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" }, + "setAutoscalerLinkOperationMetadata": { + "$ref": "SetAutoscalerLinkOperationMetadata", + "description": "This field is used internally by the Autoscaler team and should not be promoted to \"alpha/beta/v1\"." + }, "setCommonInstanceMetadataOperationMetadata": { "$ref": "SetCommonInstanceMetadataOperationMetadata", "description": "[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state." @@ -3398,6 +3406,20 @@ }, "type": "object" }, + "SetAutoscalerLinkOperationMetadata": { + "id": "SetAutoscalerLinkOperationMetadata", + "properties": { + "zonalIgmIds": { + "description": "List of zonal IGM IDs part of the RMIG.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SetCommonInstanceMetadataOperationMetadata": { "id": "SetCommonInstanceMetadataOperationMetadata", "properties": { diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index cbea2168f00..5f6031da2ca 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -195,6 +195,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -229,6 +235,388 @@ } }, "resources": { + "accountConnectors": { + "methods": { + "create": { + "description": "Creates a new AccountConnector in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors", + "httpMethod": "POST", + "id": "developerconnect.projects.locations.accountConnectors.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "accountConnectorId": { + "description": "Required. The ID to use for the AccountConnector, which will become the final component of the AccountConnector's resource name. Its format should adhere to https://google.aip.dev/122#resource-id-segments Names must be unique per-project per-location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Location resource name as the account_connector’s parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request, but do not actually post it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/accountConnectors", + "request": { + "$ref": "AccountConnector" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single AccountConnector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}", + "httpMethod": "DELETE", + "id": "developerconnect.projects.locations.accountConnectors.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The current etag of the AccountConnectorn. If an etag is provided and does not match the current etag of the AccountConnector, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any Users from this AccountConnector will also be deleted. (Otherwise, the request will only work if the AccountConnector has no Users.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request, but do not actually post it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single AccountConnector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}", + "httpMethod": "GET", + "id": "developerconnect.projects.locations.accountConnectors.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "AccountConnector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists AccountConnectors in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors", + "httpMethod": "GET", + "id": "developerconnect.projects.locations.accountConnectors.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. Parent value for ListAccountConnectorsRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/accountConnectors", + "response": { + "$ref": "ListAccountConnectorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single AccountConnector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}", + "httpMethod": "PATCH", + "id": "developerconnect.projects.locations.accountConnectors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the accountConnector is not found a new accountConnector will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input accountConnector has all the necessary", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The resource name of the accountConnector, in the format `projects/{project}/locations/{location}/accountConnectors/{account_connector_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request, but do not actually post it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "AccountConnector" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "users": { + "methods": { + "delete": { + "description": "Deletes a single User.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users/{usersId}", + "httpMethod": "DELETE", + "id": "developerconnect.projects.locations.accountConnectors.users.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "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.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+/users/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request, but do not actually post it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deleteSelf": { + "description": "Delete the User based on the user credentials.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users:deleteSelf", + "httpMethod": "DELETE", + "id": "developerconnect.projects.locations.accountConnectors.users.deleteSelf", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the AccountConnector resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/users:deleteSelf", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchAccessToken": { + "description": "Fetches OAuth access token based on end user credentials.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users:fetchAccessToken", + "httpMethod": "POST", + "id": "developerconnect.projects.locations.accountConnectors.users.fetchAccessToken", + "parameterOrder": [ + "accountConnector" + ], + "parameters": { + "accountConnector": { + "description": "Required. The resource name of the AccountConnector in the format `projects/*/locations/*/accountConnectors/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+accountConnector}/users:fetchAccessToken", + "request": { + "$ref": "FetchAccessTokenRequest" + }, + "response": { + "$ref": "FetchAccessTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchSelf": { + "description": "Fetch the User based on the user credentials.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users:fetchSelf", + "httpMethod": "GET", + "id": "developerconnect.projects.locations.accountConnectors.users.fetchSelf", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the AccountConnector resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/users:fetchSelf", + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Users in a given project, location, and account_connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users", + "httpMethod": "GET", + "id": "developerconnect.projects.locations.accountConnectors.users.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. Parent value for ListUsersRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/accountConnectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/users", + "response": { + "$ref": "ListUsersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "connections": { "methods": { "create": { @@ -1017,9 +1405,59 @@ } } }, - "revision": "20250129", + "revision": "20250414", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { + "AccountConnector": { + "description": "AccountConnector encapsulates what a platform administrator needs to configure for users to connect to the service providers, which includes, among other fields, the OAuth client ID, client secret, and authorization and token endpoints.", + "id": "AccountConnector", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Allows users to store small amounts of arbitrary data.", + "type": "object" + }, + "createTime": { + "description": "Output only. The timestamp when the accountConnector was created.", + "format": "google-datetime", + "readOnly": true, + "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" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the accountConnector, in the format `projects/{project}/locations/{location}/accountConnectors/{account_connector_id}`.", + "type": "string" + }, + "oauthStartUri": { + "description": "Output only. Start OAuth flow by clicking on this URL.", + "readOnly": true, + "type": "string" + }, + "providerOauthConfig": { + "$ref": "ProviderOAuthConfig", + "description": "Provider OAuth config." + }, + "updateTime": { + "description": "Output only. The timestamp when the accountConnector was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "BitbucketCloudConfig": { "description": "Configuration for connections to an instance of Bitbucket Cloud.", "id": "BitbucketCloudConfig", @@ -1200,6 +1638,54 @@ "properties": {}, "type": "object" }, + "ExchangeError": { + "description": "Message for representing an error from exchanging OAuth tokens.", + "id": "ExchangeError", + "properties": { + "code": { + "description": "https://datatracker.ietf.org/doc/html/rfc6749#section-5.2 - error", + "type": "string" + }, + "description": { + "description": "https://datatracker.ietf.org/doc/html/rfc6749#section-5.2 - error_description", + "type": "string" + } + }, + "type": "object" + }, + "FetchAccessTokenRequest": { + "description": "Message for fetching an OAuth access token.", + "id": "FetchAccessTokenRequest", + "properties": {}, + "type": "object" + }, + "FetchAccessTokenResponse": { + "description": "Message for responding to getting an OAuth access token.", + "id": "FetchAccessTokenResponse", + "properties": { + "exchangeError": { + "$ref": "ExchangeError", + "description": "The error resulted from exchanging OAuth tokens from the service provider." + }, + "expirationTime": { + "description": "Expiration timestamp. Can be empty if unknown or non-expiring.", + "format": "google-datetime", + "type": "string" + }, + "scopes": { + "description": "The scopes of the access token.", + "items": { + "type": "string" + }, + "type": "array" + }, + "token": { + "description": "The token content.", + "type": "string" + } + }, + "type": "object" + }, "FetchGitHubInstallationsResponse": { "description": "Response of fetching github installations.", "id": "FetchGitHubInstallationsResponse", @@ -1620,6 +2106,31 @@ }, "type": "object" }, + "ListAccountConnectorsResponse": { + "description": "Message for response to listing AccountConnectors", + "id": "ListAccountConnectorsResponse", + "properties": { + "accountConnectors": { + "description": "The list of AccountConnectors", + "items": { + "$ref": "AccountConnector" + }, + "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" + }, "ListConnectionsResponse": { "description": "Message for response to listing Connections", "id": "ListConnectionsResponse", @@ -1706,6 +2217,31 @@ }, "type": "object" }, + "ListUsersResponse": { + "description": "Message for response to listing Users", + "id": "ListUsersResponse", + "properties": { + "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" + }, + "users": { + "description": "The list of Users", + "items": { + "$ref": "User" + }, + "type": "array" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -1890,6 +2426,44 @@ }, "type": "object" }, + "ProviderOAuthConfig": { + "description": "ProviderOAuthConfig is the OAuth config for a provider.", + "id": "ProviderOAuthConfig", + "properties": { + "scopes": { + "description": "Required. User selected scopes to apply to the Oauth config In the event of changing scopes, user records under AccountConnector will be deleted and users will re-auth again.", + "items": { + "type": "string" + }, + "type": "array" + }, + "systemProviderId": { + "description": "Immutable. Developer Connect provided OAuth.", + "enum": [ + "SYSTEM_PROVIDER_UNSPECIFIED", + "GITHUB", + "GITLAB", + "GOOGLE", + "SENTRY", + "ROVO", + "NEW_RELIC", + "DATASTAX" + ], + "enumDescriptions": [ + "No system provider specified.", + "GitHub provider. Scopes can be found at https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes", + "GitLab provider. Scopes can be found at https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes", + "Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"", + "Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/", + "Rovo provider. Must select the \"rovo\" scope.", + "New Relic provider. No scopes are allowed.", + "Datastax provider. No scopes are allowed." + ], + "type": "string" + } + }, + "type": "object" + }, "ServiceDirectoryConfig": { "description": "ServiceDirectoryConfig represents Service Directory configuration for a connection.", "id": "ServiceDirectoryConfig", @@ -1928,6 +2502,34 @@ }, "type": "object" }, + "User": { + "description": "User represents a user connected to the service providers through a AccountConnector.", + "id": "User", + "properties": { + "createTime": { + "description": "Output only. The timestamp when the user was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. Developer Connect automatically converts user identity to some human readable description, e.g., email address.", + "readOnly": true, + "type": "string" + }, + "lastTokenRequestTime": { + "description": "Output only. The timestamp when the token was last requested.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. Resource name of the user, in the format `projects/*/locations/*/accountConnectors/*/users/*`.", + "type": "string" + } + }, + "type": "object" + }, "UserCredential": { "description": "Represents a personal access token that authorized the Connection, and associated metadata.", "id": "UserCredential", diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 0ccabe378ae..1fa13b6e58e 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -4406,6 +4406,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -8799,7 +8805,7 @@ } } }, - "revision": "20250310", + "revision": "20250422", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -10171,6 +10177,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3TextInput", "description": "The natural language text to be processed." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResult", + "description": "The results of a tool executed by the client." } }, "type": "object" @@ -10244,6 +10254,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText", "description": "Returns a text response." + }, + "toolCall": { + "$ref": "GoogleCloudDialogflowCxV3ToolCall", + "description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -10638,6 +10652,67 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowCxV3ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCallResult": { + "description": "The result of calling a tool's action that has been executed by the client.", + "id": "GoogleCloudDialogflowCxV3ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResultError", + "description": "The tool call's error." + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The tool call's output parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowCxV3ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3TransitionRoute", @@ -10834,6 +10909,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -10895,6 +10981,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -10902,6 +10992,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -13209,6 +13310,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -13270,6 +13382,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -13277,6 +13393,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", @@ -14993,6 +15120,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2CustomPronunciationParams": { + "description": "Pronunciation customization for a phrase.", + "id": "GoogleCloudDialogflowV2CustomPronunciationParams", + "properties": { + "phoneticEncoding": { + "description": "The phonetic encoding of the phrase.", + "enum": [ + "PHONETIC_ENCODING_UNSPECIFIED", + "PHONETIC_ENCODING_IPA", + "PHONETIC_ENCODING_X_SAMPA" + ], + "enumDescriptions": [ + "Not specified.", + "IPA, such as apple -> ˈæpəl. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet", + "X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA" + ], + "type": "string" + }, + "phrase": { + "description": "The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.", + "type": "string" + }, + "pronunciation": { + "description": "The pronunciation of the phrase. This must be in the phonetic encoding specified above.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata": { "description": "Metadata for DeleteConversationDataset.", "id": "GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata", @@ -15987,6 +16143,13 @@ "$ref": "GoogleCloudDialogflowV2SummarizationContext", "description": "Input of prebuilt Summarization feature." }, + "tools": { + "description": "Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.", + "items": { + "type": "string" + }, + "type": "array" + }, "triggerEvent": { "description": "Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.", "enum": [ @@ -16025,6 +16188,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -16662,7 +16847,7 @@ "type": "boolean" }, "languageCode": { - "description": "Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "description": "Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not set, the language is inferred from the ConversationProfile.stt_config.", "type": "string" }, "model": { @@ -19228,7 +19413,7 @@ "type": "boolean" }, "languageCode": { - "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not specified, the default language configured at ConversationProfile is used.", "type": "string" }, "model": { @@ -19785,6 +19970,13 @@ "format": "double", "type": "number" }, + "pronunciations": { + "description": "Optional. The custom pronunciations for the synthesized audio.", + "items": { + "$ref": "GoogleCloudDialogflowV2CustomPronunciationParams" + }, + "type": "array" + }, "speakingRate": { "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", "format": "double", @@ -19862,6 +20054,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2TrainAgentRequest": { "description": "The request message for Agents.TrainAgent.", "id": "GoogleCloudDialogflowV2TrainAgentRequest", @@ -20549,6 +20815,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -22543,15 +22831,15 @@ "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", - "DTMF_DIGITS", "END_OF_SINGLE_UTTERANCE", + "DTMF_DIGITS", "PARTIAL_DTMF_DIGITS" ], "enumDescriptions": [ "Not specified. Should never be used.", "Message contains a (possibly partial) transcript.", - "Message contains DTMF digits.", "This event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if `single_utterance` was set to `true`, and is not used otherwise.", + "Message contains DTMF digits.", "Message contains DTMF digits. Before a message with DTMF_DIGITS is sent, a message with PARTIAL_DTMF_DIGITS may be sent with DTMF digits collected up to the time of sending, which represents an intermediate result." ], "type": "string" @@ -22813,6 +23101,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2beta1ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1WebhookRequest": { "description": "The request message for a webhook call.", "id": "GoogleCloudDialogflowV2beta1WebhookRequest", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index b00d6b25594..780d262b3a0 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -4171,6 +4171,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -8596,7 +8602,7 @@ } } }, - "revision": "20250310", + "revision": "20250422", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -9968,6 +9974,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3TextInput", "description": "The natural language text to be processed." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResult", + "description": "The results of a tool executed by the client." } }, "type": "object" @@ -10041,6 +10051,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText", "description": "Returns a text response." + }, + "toolCall": { + "$ref": "GoogleCloudDialogflowCxV3ToolCall", + "description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -10435,6 +10449,67 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowCxV3ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCallResult": { + "description": "The result of calling a tool's action that has been executed by the client.", + "id": "GoogleCloudDialogflowCxV3ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResultError", + "description": "The tool call's error." + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The tool call's output parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowCxV3ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3TransitionRoute", @@ -10631,6 +10706,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -10692,6 +10778,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -10699,6 +10789,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -13006,6 +13107,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -13067,6 +13179,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -13074,6 +13190,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", @@ -13971,6 +14098,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -15709,6 +15858,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "description": "Metadata for a ConversationModels.UndeployConversationModel operation.", "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", @@ -17226,6 +17449,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1CustomPronunciationParams": { + "description": "Pronunciation customization for a phrase.", + "id": "GoogleCloudDialogflowV2beta1CustomPronunciationParams", + "properties": { + "phoneticEncoding": { + "description": "The phonetic encoding of the phrase.", + "enum": [ + "PHONETIC_ENCODING_UNSPECIFIED", + "PHONETIC_ENCODING_IPA", + "PHONETIC_ENCODING_X_SAMPA" + ], + "enumDescriptions": [ + "Not specified.", + "IPA, such as apple -> ˈæpəl. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet", + "X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA" + ], + "type": "string" + }, + "phrase": { + "description": "The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.", + "type": "string" + }, + "pronunciation": { + "description": "The pronunciation of the phrase. This must be in the phonetic encoding specified above.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1DetectIntentRequest": { "description": "The request to detect user's intent.", "id": "GoogleCloudDialogflowV2beta1DetectIntentRequest", @@ -18128,6 +18380,13 @@ "$ref": "GoogleCloudDialogflowV2beta1SummarizationContext", "description": "Input of Summarization feature." }, + "tools": { + "description": "Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.", + "items": { + "type": "string" + }, + "type": "array" + }, "triggerEvent": { "description": "Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.", "enum": [ @@ -18166,6 +18425,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -18764,7 +19045,7 @@ "type": "boolean" }, "languageCode": { - "description": "Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "description": "Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not set, the language is inferred from the ConversationProfile.stt_config.", "type": "string" }, "model": { @@ -21820,7 +22101,7 @@ "type": "boolean" }, "languageCode": { - "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not specified, the default language configured at ConversationProfile is used.", "type": "string" }, "model": { @@ -21914,15 +22195,15 @@ "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", - "DTMF_DIGITS", "END_OF_SINGLE_UTTERANCE", + "DTMF_DIGITS", "PARTIAL_DTMF_DIGITS" ], "enumDescriptions": [ "Not specified. Should never be used.", "Message contains a (possibly partial) transcript.", - "Message contains DTMF digits.", "This event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if `single_utterance` was set to `true`, and is not used otherwise.", + "Message contains DTMF digits.", "Message contains DTMF digits. Before a message with DTMF_DIGITS is sent, a message with PARTIAL_DTMF_DIGITS may be sent with DTMF digits collected up to the time of sending, which represents an intermediate result." ], "type": "string" @@ -22556,6 +22837,13 @@ "format": "double", "type": "number" }, + "pronunciations": { + "description": "Optional. The custom pronunciations for the synthesized audio.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1CustomPronunciationParams" + }, + "type": "array" + }, "speakingRate": { "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", "format": "double", @@ -22685,6 +22973,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2beta1ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1TrainAgentRequest": { "description": "The request message for Agents.TrainAgent.", "id": "GoogleCloudDialogflowV2beta1TrainAgentRequest", diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 1d9aa2ee09a..7e6b57b549f 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -147,6 +147,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -3033,147 +3039,213 @@ } } }, - "sessions": { + "playbooks": { "methods": { - "detectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:detectIntent", + "create": { + "description": "Creates a playbook in a specified agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.sessions.detectIntent", + "id": "dialogflow.projects.locations.agents.playbooks.create", "parameterOrder": [ - "session" + "parent" ], "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "parent": { + "description": "Required. The agent to create a playbook for. Format: `projects//locations//agents/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+session}:detectIntent", + "path": "v3/{+parent}/playbooks", "request": { - "$ref": "GoogleCloudDialogflowCxV3DetectIntentRequest" + "$ref": "GoogleCloudDialogflowCxV3Playbook" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3DetectIntentResponse" + "$ref": "GoogleCloudDialogflowCxV3Playbook" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "fulfillIntent": { - "description": "Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:fulfillIntent", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.sessions.fulfillIntent", + "delete": { + "description": "Deletes a specified playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.playbooks.delete", "parameterOrder": [ - "session" + "name" ], "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", + "name": { + "description": "Required. The name of the playbook to delete. Format: `projects//locations//agents//playbooks/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+session}:fulfillIntent", - "request": { - "$ref": "GoogleCloudDialogflowCxV3FulfillIntentRequest" - }, + "path": "v3/{+name}", "response": { - "$ref": "GoogleCloudDialogflowCxV3FulfillIntentResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "matchIntent": { - "description": "Returns preliminary intent match results, doesn't change the session status.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:matchIntent", + "export": { + "description": "Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}:export", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.sessions.matchIntent", + "id": "dialogflow.projects.locations.agents.playbooks.export", "parameterOrder": [ - "session" + "name" ], "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", + "name": { + "description": "Required. The name of the playbook to export. Format: `projects//locations//agents//playbooks/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+session}:matchIntent", + "path": "v3/{+name}:export", "request": { - "$ref": "GoogleCloudDialogflowCxV3MatchIntentRequest" + "$ref": "GoogleCloudDialogflowCxV3ExportPlaybookRequest" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3MatchIntentResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "serverStreamingDetectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:serverStreamingDetectIntent", + "get": { + "description": "Retrieves the specified Playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.playbooks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the playbook. Format: `projects//locations//agents//playbooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Playbook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "import": { + "description": "Imports the specified playbook to the specified agent from a binary file.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks:import", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.sessions.serverStreamingDetectIntent", + "id": "dialogflow.projects.locations.agents.playbooks.import", "parameterOrder": [ - "session" + "parent" ], "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "parent": { + "description": "Required. The agent to import the playbook into. Format: `projects//locations//agents/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+session}:serverStreamingDetectIntent", + "path": "v3/{+parent}/playbooks:import", "request": { - "$ref": "GoogleCloudDialogflowCxV3DetectIntentRequest" + "$ref": "GoogleCloudDialogflowCxV3ImportPlaybookRequest" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3DetectIntentResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "submitAnswerFeedback": { - "description": "Updates the feedback received from the user for a single turn of the bot response.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:submitAnswerFeedback", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.sessions.submitAnswerFeedback", + "list": { + "description": "Returns a list of playbooks in the specified agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.playbooks.list", "parameterOrder": [ - "session" + "parent" ], "parameters": { - "session": { - "description": "Required. The name of the session the feedback was sent to.", + "pageSize": { + "description": "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": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list playbooks from. Format: `projects//locations//agents/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+session}:submitAnswerFeedback", + "path": "v3/{+parent}/playbooks", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListPlaybooksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified Playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.playbooks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", "request": { - "$ref": "GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest" + "$ref": "GoogleCloudDialogflowCxV3Playbook" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3AnswerFeedback" + "$ref": "GoogleCloudDialogflowCxV3Playbook" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3182,31 +3254,31 @@ } }, "resources": { - "entityTypes": { + "examples": { "methods": { "create": { - "description": "Creates a session entity type.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes", + "description": "Creates an example in the specified playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.sessions.entityTypes.create", + "id": "dialogflow.projects.locations.agents.playbooks.examples.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "description": "Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/entityTypes", + "path": "v3/{+parent}/examples", "request": { - "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + "$ref": "GoogleCloudDialogflowCxV3Example" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + "$ref": "GoogleCloudDialogflowCxV3Example" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3214,18 +3286,18 @@ ] }, "delete": { - "description": "Deletes the specified session entity type.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "description": "Deletes the specified example.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}", "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agents.sessions.entityTypes.delete", + "id": "dialogflow.projects.locations.agents.playbooks.examples.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "description": "Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$", "required": true, "type": "string" } @@ -3240,25 +3312,25 @@ ] }, "get": { - "description": "Retrieves the specified session entity type.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "description": "Retrieves the specified example.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}", "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.sessions.entityTypes.get", + "id": "dialogflow.projects.locations.agents.playbooks.examples.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "description": "Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$", "required": true, "type": "string" } }, "path": "v3/{+name}", "response": { - "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + "$ref": "GoogleCloudDialogflowCxV3Example" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3266,36 +3338,41 @@ ] }, "list": { - "description": "Returns the list of all session entity types in the specified session.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes", + "description": "Returns a list of examples in the specified playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples", "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.sessions.entityTypes.list", + "id": "dialogflow.projects.locations.agents.playbooks.examples.list", "parameterOrder": [ "parent" ], "parameters": { + "languageCode": { + "description": "Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "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": "The next_page_token value returned from a previous list request.", + "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "description": "Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/entityTypes", + "path": "v3/{+parent}/examples", "response": { - "$ref": "GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse" + "$ref": "GoogleCloudDialogflowCxV3ListExamplesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3303,23 +3380,23 @@ ] }, "patch": { - "description": "Updates the specified session entity type.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "description": "Update the specified example.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}", "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agents.sessions.entityTypes.patch", + "id": "dialogflow.projects.locations.agents.playbooks.examples.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "description": "The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "The mask to control which fields get updated.", + "description": "Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3327,10 +3404,10 @@ }, "path": "v3/{+name}", "request": { - "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + "$ref": "GoogleCloudDialogflowCxV3Example" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + "$ref": "GoogleCloudDialogflowCxV3Example" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3338,335 +3415,301 @@ ] } } - } - } - }, - "testCases": { - "methods": { - "batchDelete": { - "description": "Batch deletes test cases.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchDelete", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.testCases.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The agent to delete test cases from. Format: `projects//locations//agents/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v3/{+parent}/testCases:batchDelete", - "request": { - "$ref": "GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchRun": { - "description": "Kicks off a batch run of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchRun", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.testCases.batchRun", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Agent name. Format: `projects//locations//agents/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v3/{+parent}/testCases:batchRun", - "request": { - "$ref": "GoogleCloudDialogflowCxV3BatchRunTestCasesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] }, - "calculateCoverage": { - "description": "Calculates the test coverage for an agent.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:calculateCoverage", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.testCases.calculateCoverage", - "parameterOrder": [ - "agent" - ], - "parameters": { - "agent": { - "description": "Required. The agent to calculate coverage for. Format: `projects//locations//agents/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" + "versions": { + "methods": { + "create": { + "description": "Creates a version for the specified Playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.playbooks.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/versions", + "request": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookVersion" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] }, - "type": { - "description": "Required. The type of coverage requested.", - "enum": [ - "COVERAGE_TYPE_UNSPECIFIED", - "INTENT", - "PAGE_TRANSITION", - "TRANSITION_ROUTE_GROUP" + "delete": { + "description": "Deletes the specified version of the Playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.playbooks.versions.delete", + "parameterOrder": [ + "name" ], - "enumDescriptions": [ - "Should never be used.", - "Intent coverage.", - "Page transition coverage.", - "Transition route group coverage." + "parameters": { + "name": { + "description": "Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+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 Playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.playbooks.versions.get", + "parameterOrder": [ + "name" ], - "location": "query", + "parameters": { + "name": { + "description": "Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Lists versions for the specified Playbook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.playbooks.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 playbook to list versions for. Format: `projects//locations//agents//playbooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/versions", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListPlaybookVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "restore": { + "description": "Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}:restore", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.playbooks.versions.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:restore", + "request": { + "$ref": "GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3RestorePlaybookVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "sessions": { + "methods": { + "detectIntent": { + "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:detectIntent", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.sessions.detectIntent", + "parameterOrder": [ + "session" + ], + "parameters": { + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "required": true, "type": "string" } }, - "path": "v3/{+agent}/testCases:calculateCoverage", + "path": "v3/{+session}:detectIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3DetectIntentRequest" + }, "response": { - "$ref": "GoogleCloudDialogflowCxV3CalculateCoverageResponse" + "$ref": "GoogleCloudDialogflowCxV3DetectIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "create": { - "description": "Creates a test case for the given agent.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases", + "fulfillIntent": { + "description": "Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:fulfillIntent", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.testCases.create", + "id": "dialogflow.projects.locations.agents.sessions.fulfillIntent", "parameterOrder": [ - "parent" + "session" ], "parameters": { - "parent": { - "description": "Required. The agent to create the test case for. Format: `projects//locations//agents/`.", + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/testCases", + "path": "v3/{+session}:fulfillIntent", "request": { - "$ref": "GoogleCloudDialogflowCxV3TestCase" + "$ref": "GoogleCloudDialogflowCxV3FulfillIntentRequest" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3TestCase" + "$ref": "GoogleCloudDialogflowCxV3FulfillIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "export": { - "description": "Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportTestCasesMetadata - `response`: ExportTestCasesResponse", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:export", + "matchIntent": { + "description": "Returns preliminary intent match results, doesn't change the session status.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:matchIntent", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.testCases.export", + "id": "dialogflow.projects.locations.agents.sessions.matchIntent", "parameterOrder": [ - "parent" + "session" ], "parameters": { - "parent": { - "description": "Required. The agent where to export test cases from. Format: `projects//locations//agents/`.", + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/testCases:export", + "path": "v3/{+session}:matchIntent", "request": { - "$ref": "GoogleCloudDialogflowCxV3ExportTestCasesRequest" + "$ref": "GoogleCloudDialogflowCxV3MatchIntentRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudDialogflowCxV3MatchIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "get": { - "description": "Gets a test case.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.testCases.get", + "serverStreamingDetectIntent": { + "description": "Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:serverStreamingDetectIntent", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.sessions.serverStreamingDetectIntent", "parameterOrder": [ - "name" + "session" ], "parameters": { - "name": { - "description": "Required. The name of the testcase. Format: `projects//locations//agents//testCases/`.", + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+name}", + "path": "v3/{+session}:serverStreamingDetectIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3DetectIntentRequest" + }, "response": { - "$ref": "GoogleCloudDialogflowCxV3TestCase" + "$ref": "GoogleCloudDialogflowCxV3DetectIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "import": { - "description": "Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:import", + "submitAnswerFeedback": { + "description": "Updates the feedback received from the user for a single turn of the bot response.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:submitAnswerFeedback", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.testCases.import", + "id": "dialogflow.projects.locations.agents.sessions.submitAnswerFeedback", "parameterOrder": [ - "parent" + "session" ], "parameters": { - "parent": { - "description": "Required. The agent to import test cases to. Format: `projects//locations//agents/`.", + "session": { + "description": "Required. The name of the session the feedback was sent to.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/testCases:import", + "path": "v3/{+session}:submitAnswerFeedback", "request": { - "$ref": "GoogleCloudDialogflowCxV3ImportTestCasesRequest" + "$ref": "GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Fetches a list of test cases for a given agent.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.testCases.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to list all pages for. Format: `projects//locations//agents/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - }, - "view": { - "description": "Specifies whether response should include all fields or just the metadata.", - "enum": [ - "TEST_CASE_VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Include basic metadata about the test case, but not the conversation turns. This is the default value.", - "Include everything." - ], - "location": "query", - "type": "string" - } - }, - "path": "v3/{+parent}/testCases", - "response": { - "$ref": "GoogleCloudDialogflowCxV3ListTestCasesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified test case.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agents.testCases.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The mask to specify which fields should be updated. The `creationTime` and `lastTestResult` cannot be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v3/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowCxV3TestCase" - }, - "response": { - "$ref": "GoogleCloudDialogflowCxV3TestCase" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "run": { - "description": "Kicks off a test case run. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}:run", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.testCases.run", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Format of test case name to run: `projects//locations//agents//testCases/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v3/{+name}:run", - "request": { - "$ref": "GoogleCloudDialogflowCxV3RunTestCaseRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudDialogflowCxV3AnswerFeedback" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3675,28 +3718,83 @@ } }, "resources": { - "results": { + "entityTypes": { "methods": { + "create": { + "description": "Creates a session entity type.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/entityTypes", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified session entity type.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "get": { - "description": "Gets a test case result.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results/{resultsId}", + "description": "Retrieves the specified session entity type.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.testCases.results.get", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the testcase. Format: `projects//locations//agents//testCases//results/`.", + "description": "Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+/results/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, "path": "v3/{+name}", "response": { - "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3704,19 +3802,14 @@ ] }, "list": { - "description": "Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results", + "description": "Returns the list of all session entity types in the specified session.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes", "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.testCases.results.list", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.list", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `>`, `<` `latest` only returns the latest test result in all results for each test case. Examples: * \"environment=draft AND latest\" matches the latest test result for each test case in the draft environment. * \"environment IN (e1,e2)\" matches any test case results with an environment resource name of either \"e1\" or \"e2\". * \"test_time > 1602540713\" matches any test case results with test time later than a unix timestamp in seconds 1602540713.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", "format": "int32", @@ -3729,16 +3822,51 @@ "type": "string" }, "parent": { - "description": "Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", + "description": "Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/results", + "path": "v3/{+parent}/entityTypes", "response": { - "$ref": "GoogleCloudDialogflowCxV3ListTestCaseResultsResponse" + "$ref": "GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified session entity type.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -3749,270 +3877,216 @@ } } }, - "transitionRouteGroups": { + "testCases": { "methods": { - "create": { - "description": "Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups", + "batchDelete": { + "description": "Batch deletes test cases.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchDelete", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.transitionRouteGroups.create", + "id": "dialogflow.projects.locations.agents.testCases.batchDelete", "parameterOrder": [ "parent" ], "parameters": { - "languageCode": { - "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/` for agent-level groups.", + "description": "Required. The agent to delete test cases from. Format: `projects//locations//agents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/transitionRouteGroups", + "path": "v3/{+parent}/testCases:batchDelete", "request": { - "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + "$ref": "GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "delete": { - "description": "Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agents.transitionRouteGroups.delete", + "batchRun": { + "description": "Kicks off a batch run of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchRun", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.batchRun", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "force": { - "description": "This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If `force` is set to false, an error will be returned with message indicating pages that reference the transition route group. * If `force` is set to true, Dialogflow will remove the transition route group, as well as any reference to it.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the TransitionRouteGroup to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.", + "parent": { + "description": "Required. Agent name. Format: `projects//locations//agents/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+name}", + "path": "v3/{+parent}/testCases:batchRun", + "request": { + "$ref": "GoogleCloudDialogflowCxV3BatchRunTestCasesRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "get": { - "description": "Retrieves the specified TransitionRouteGroup.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}", + "calculateCoverage": { + "description": "Calculates the test coverage for an agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:calculateCoverage", "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.transitionRouteGroups.get", + "id": "dialogflow.projects.locations.agents.testCases.calculateCoverage", "parameterOrder": [ - "name" + "agent" ], "parameters": { - "languageCode": { - "description": "The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.", + "agent": { + "description": "Required. The agent to calculate coverage for. Format: `projects//locations//agents/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v3/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all transition route groups in the specified flow.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.transitionRouteGroups.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "languageCode": { - "description": "The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "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": "The next_page_token value returned from a previous list request.", + "type": { + "description": "Required. The type of coverage requested.", + "enum": [ + "COVERAGE_TYPE_UNSPECIFIED", + "INTENT", + "PAGE_TRANSITION", + "TRANSITION_ROUTE_GROUP" + ], + "enumDescriptions": [ + "Should never be used.", + "Intent coverage.", + "Page transition coverage.", + "Transition route group coverage." + ], "location": "query", "type": "string" - }, - "parent": { - "description": "Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" } }, - "path": "v3/{+parent}/transitionRouteGroups", + "path": "v3/{+agent}/testCases:calculateCoverage", "response": { - "$ref": "GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse" + "$ref": "GoogleCloudDialogflowCxV3CalculateCoverageResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "patch": { - "description": "Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agents.transitionRouteGroups.patch", + "create": { + "description": "Creates a test case for the given agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "languageCode": { - "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/` .", + "parent": { + "description": "Required. The agent to create the test case for. Format: `projects//locations//agents/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v3/{+name}", + "path": "v3/{+parent}/testCases", "request": { - "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + "$ref": "GoogleCloudDialogflowCxV3TestCase" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + "$ref": "GoogleCloudDialogflowCxV3TestCase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] - } - } - }, - "webhooks": { - "methods": { - "create": { - "description": "Creates a webhook in the specified agent.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks", + }, + "export": { + "description": "Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportTestCasesMetadata - `response`: ExportTestCasesResponse", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:export", "httpMethod": "POST", - "id": "dialogflow.projects.locations.agents.webhooks.create", + "id": "dialogflow.projects.locations.agents.testCases.export", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The agent to create a webhook for. Format: `projects//locations//agents/`.", + "description": "Required. The agent where to export test cases from. Format: `projects//locations//agents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+parent}/webhooks", + "path": "v3/{+parent}/testCases:export", "request": { - "$ref": "GoogleCloudDialogflowCxV3Webhook" + "$ref": "GoogleCloudDialogflowCxV3ExportTestCasesRequest" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3Webhook" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "delete": { - "description": "Deletes the specified webhook.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agents.webhooks.delete", + "get": { + "description": "Gets a test case.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.testCases.get", "parameterOrder": [ "name" ], "parameters": { - "force": { - "description": "This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * 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 webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`.", + "description": "Required. The name of the testcase. Format: `projects//locations//agents//testCases/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, "type": "string" } }, "path": "v3/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudDialogflowCxV3TestCase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] }, - "get": { - "description": "Retrieves the specified webhook.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.webhooks.get", + "import": { + "description": "Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:import", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.import", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`.", + "parent": { + "description": "Required. The agent to import test cases to. Format: `projects//locations//agents/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" } }, - "path": "v3/{+name}", + "path": "v3/{+parent}/testCases:import", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ImportTestCasesRequest" + }, "response": { - "$ref": "GoogleCloudDialogflowCxV3Webhook" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -4020,16 +4094,16 @@ ] }, "list": { - "description": "Returns the list of all webhooks in the specified agent.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks", + "description": "Fetches a list of test cases for a given agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases", "httpMethod": "GET", - "id": "dialogflow.projects.locations.agents.webhooks.list", + "id": "dialogflow.projects.locations.agents.testCases.list", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { - "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "description": "The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.", "format": "int32", "location": "query", "type": "integer" @@ -4040,16 +4114,31 @@ "type": "string" }, "parent": { - "description": "Required. The agent to list all webhooks for. Format: `projects//locations//agents/`.", + "description": "Required. The agent to list all pages for. Format: `projects//locations//agents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Specifies whether response should include all fields or just the metadata.", + "enum": [ + "TEST_CASE_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the test case, but not the conversation turns. This is the default value.", + "Include everything." + ], + "location": "query", + "type": "string" } }, - "path": "v3/{+parent}/webhooks", + "path": "v3/{+parent}/testCases", "response": { - "$ref": "GoogleCloudDialogflowCxV3ListWebhooksResponse" + "$ref": "GoogleCloudDialogflowCxV3ListTestCasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -4057,23 +4146,23 @@ ] }, "patch": { - "description": "Updates the specified webhook.", - "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}", + "description": "Updates the specified test case.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}", "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agents.webhooks.patch", + "id": "dialogflow.projects.locations.agents.testCases.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "description": "Required. The mask to specify which fields should be updated. The `creationTime` and `lastTestResult` cannot be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4081,16 +4170,625 @@ }, "path": "v3/{+name}", "request": { - "$ref": "GoogleCloudDialogflowCxV3Webhook" + "$ref": "GoogleCloudDialogflowCxV3TestCase" }, "response": { - "$ref": "GoogleCloudDialogflowCxV3Webhook" + "$ref": "GoogleCloudDialogflowCxV3TestCase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] - } + }, + "run": { + "description": "Kicks off a test case run. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}:run", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format of test case name to run: `projects//locations//agents//testCases/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:run", + "request": { + "$ref": "GoogleCloudDialogflowCxV3RunTestCaseRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + }, + "resources": { + "results": { + "methods": { + "get": { + "description": "Gets a test case result.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results/{resultsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.testCases.results.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the testcase. Format: `projects//locations//agents//testCases//results/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+/results/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.testCases.results.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `>`, `<` `latest` only returns the latest test result in all results for each test case. Examples: * \"environment=draft AND latest\" matches the latest test result for each test case in the draft environment. * \"environment IN (e1,e2)\" matches any test case results with an environment resource name of either \"e1\" or \"e2\". * \"test_time > 1602540713\" matches any test case results with test time later than a unix timestamp in seconds 1602540713.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "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": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/results", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListTestCaseResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "tools": { + "methods": { + "create": { + "description": "Creates a Tool in the specified agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.tools.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a Tool for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/tools", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Tool" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Tool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes a specified Tool.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.tools.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "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 to be deleted. Format: `projects//locations//agents//tools/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified Tool.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.tools.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Tool. Format: `projects//locations//agents//tools/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Tool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns a list of Tools in the specified agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.tools.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list the Tools from. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/tools", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListToolsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Update the specified Tool.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.tools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Tool" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Tool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "transitionRouteGroups": { + "methods": { + "create": { + "description": "Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.transitionRouteGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/` for agent-level groups.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/transitionRouteGroups", + "request": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.transitionRouteGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If `force` is set to false, an error will be returned with message indicating pages that reference the transition route group. * If `force` is set to true, Dialogflow will remove the transition route group, as well as any reference to it.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the TransitionRouteGroup to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified TransitionRouteGroup.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.transitionRouteGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all transition route groups in the specified flow.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.transitionRouteGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "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": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/transitionRouteGroups", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.transitionRouteGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/` .", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "webhooks": { + "methods": { + "create": { + "description": "Creates a webhook in the specified agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.webhooks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a webhook for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/webhooks", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified webhook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.webhooks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * 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 webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified webhook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.webhooks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all webhooks in the specified agent.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.webhooks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all webhooks for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/webhooks", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListWebhooksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified webhook.", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.webhooks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } } } } @@ -4453,9 +5151,36 @@ } } }, - "revision": "20250310", + "revision": "20250422", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { + "GoogleCloudDialogflowCxV3Action": { + "description": "Action performed by end user or Dialogflow agent in the conversation.", + "id": "GoogleCloudDialogflowCxV3Action", + "properties": { + "agentUtterance": { + "$ref": "GoogleCloudDialogflowCxV3AgentUtterance", + "description": "Optional. Action performed by the agent as a message." + }, + "flowInvocation": { + "$ref": "GoogleCloudDialogflowCxV3FlowInvocation", + "description": "Optional. Action performed on behalf of the agent by invoking a CX flow." + }, + "playbookInvocation": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookInvocation", + "description": "Optional. Action performed on behalf of the agent by invoking a child playbook." + }, + "toolUse": { + "$ref": "GoogleCloudDialogflowCxV3ToolUse", + "description": "Optional. Action performed on behalf of the agent by calling a plugin tool." + }, + "userUtterance": { + "$ref": "GoogleCloudDialogflowCxV3UserUtterance", + "description": "Optional. Agent obtained a message from the customer." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3AdvancedSettings": { "description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.", "id": "GoogleCloudDialogflowCxV3AdvancedSettings", @@ -4640,7 +5365,11 @@ "description": "Speech recognition related settings." }, "startFlow": { - "description": "Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.", + "description": "Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id \"00000000-0000-0000-0000-000000000000\" is allowed.", + "type": "string" + }, + "startPlaybook": { + "description": "Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id \"00000000-0000-0000-0000-000000000000\" is allowed.", "type": "string" }, "supportedLanguageCodes": { @@ -4758,6 +5487,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3AgentUtterance": { + "description": "AgentUtterance represents one message sent by the agent.", + "id": "GoogleCloudDialogflowCxV3AgentUtterance", + "properties": { + "text": { + "description": "Required. Message content in text.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3AgentValidationResult": { "description": "The response message for Agents.GetAgentValidationResult.", "id": "GoogleCloudDialogflowCxV3AgentValidationResult", @@ -5950,6 +6690,82 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3Example": { + "description": "Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.", + "id": "GoogleCloudDialogflowCxV3Example", + "properties": { + "actions": { + "description": "Required. The ordered list of actions performed by the end user and the Dialogflow agent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Action" + }, + "type": "array" + }, + "conversationState": { + "description": "Required. Example's output state.", + "enum": [ + "OUTPUT_STATE_UNSPECIFIED", + "OUTPUT_STATE_OK", + "OUTPUT_STATE_CANCELLED", + "OUTPUT_STATE_FAILED", + "OUTPUT_STATE_ESCALATED", + "OUTPUT_STATE_PENDING" + ], + "enumDescriptions": [ + "Unspecified output.", + "Succeeded.", + "Cancelled.", + "Failed.", + "Escalated.", + "Pending." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp of initial example creation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The high level concise description of the example. The max number of characters is 200.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the example.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.", + "type": "string" + }, + "name": { + "description": "The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.", + "type": "string" + }, + "playbookInput": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookInput", + "description": "Optional. The input to the playbook in the example." + }, + "playbookOutput": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookOutput", + "description": "Optional. The output of the playbook in the example." + }, + "tokenCount": { + "description": "Output only. Estimated number of tokes current example takes when sent to the LLM.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last time the example was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3Experiment": { "description": "Represents an experiment in an environment.", "id": "GoogleCloudDialogflowCxV3Experiment", @@ -6396,8 +7212,33 @@ "$ref": "GoogleCloudDialogflowCxV3InlineDestination", "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." }, - "intentsUri": { - "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportPlaybookRequest": { + "description": "The request message for Playbooks.ExportPlaybook.", + "id": "GoogleCloudDialogflowCxV3ExportPlaybookRequest", + "properties": { + "dataFormat": { + "description": "Optional. The data format of the exported agent. If not specified, `BLOB` is assumed.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "BLOB", + "JSON" + ], + "enumDescriptions": [ + "Unspecified format.", + "Flow content will be exported as raw bytes.", + "Flow content will be exported in JSON format." + ], + "type": "string" + }, + "playbookUri": { + "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the playbook to. The format of this URI must be `gs:///`. If left unspecified, the serialized playbook is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", "type": "string" } }, @@ -6559,6 +7400,42 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3FlowInvocation": { + "description": "Stores metadata of the invocation of a CX flow.", + "id": "GoogleCloudDialogflowCxV3FlowInvocation", + "properties": { + "displayName": { + "description": "Output only. The display name of the flow.", + "readOnly": true, + "type": "string" + }, + "flow": { + "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "flowState": { + "description": "Required. Flow invocation's output state.", + "enum": [ + "OUTPUT_STATE_UNSPECIFIED", + "OUTPUT_STATE_OK", + "OUTPUT_STATE_CANCELLED", + "OUTPUT_STATE_FAILED", + "OUTPUT_STATE_ESCALATED", + "OUTPUT_STATE_PENDING" + ], + "enumDescriptions": [ + "Unspecified output.", + "Succeeded.", + "Cancelled.", + "Failed.", + "Escalated.", + "Pending." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3FlowMultiLanguageSettings": { "description": "Settings for multi-lingual agents.", "id": "GoogleCloudDialogflowCxV3FlowMultiLanguageSettings", @@ -6855,6 +7732,10 @@ "description": "Language for this settings.", "type": "string" }, + "llmModelSettings": { + "$ref": "GoogleCloudDialogflowCxV3LlmModelSettings", + "description": "LLM model settings." + }, "name": { "description": "Format: `projects//locations//agents//generativeSettings`.", "type": "string" @@ -6938,6 +7819,10 @@ "description": "Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.", "type": "string" }, + "llmModelSettings": { + "$ref": "GoogleCloudDialogflowCxV3LlmModelSettings", + "description": "The LLM model settings." + }, "modelParameter": { "$ref": "GoogleCloudDialogflowCxV3GeneratorModelParameter", "description": "Parameters passed to the LLM to configure its behavior." @@ -7222,6 +8107,26 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportPlaybookRequest": { + "description": "The request message for Playbooks.ImportPlaybook.", + "id": "GoogleCloudDialogflowCxV3ImportPlaybookRequest", + "properties": { + "importStrategy": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookImportStrategy", + "description": "Optional. Specifies the import strategy used when resolving resource conflicts." + }, + "playbookContent": { + "description": "Uncompressed raw byte content for playbook.", + "format": "byte", + "type": "string" + }, + "playbookUri": { + "description": "[Dialogflow access control] (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -7686,6 +8591,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ListExamplesResponse": { + "description": "The response message for Examples.ListExamples.", + "id": "GoogleCloudDialogflowCxV3ListExamplesResponse", + "properties": { + "examples": { + "description": "The list of examples. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Example" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ListExperimentsResponse": { "description": "The response message for Experiments.ListExperiments.", "id": "GoogleCloudDialogflowCxV3ListExperimentsResponse", @@ -7776,6 +8699,42 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ListPlaybookVersionsResponse": { + "description": "The response message for Playbooks.ListPlaybookVersions.", + "id": "GoogleCloudDialogflowCxV3ListPlaybookVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "playbookVersions": { + "description": "The list of playbook version. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookVersion" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListPlaybooksResponse": { + "description": "The response message for Playbooks.ListPlaybooks.", + "id": "GoogleCloudDialogflowCxV3ListPlaybooksResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "playbooks": { + "description": "The list of playbooks. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Playbook" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ListSecuritySettingsResponse": { "description": "The response message for SecuritySettings.ListSecuritySettings.", "id": "GoogleCloudDialogflowCxV3ListSecuritySettingsResponse", @@ -7848,6 +8807,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ListToolsResponse": { + "description": "The response message for Tools.ListTools.", + "id": "GoogleCloudDialogflowCxV3ListToolsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "tools": { + "description": "The list of Tools. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Tool" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse": { "description": "The response message for TransitionRouteGroups.ListTransitionRouteGroups.", "id": "GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse", @@ -7902,6 +8879,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3LlmModelSettings": { + "description": "Settings for LLM models.", + "id": "GoogleCloudDialogflowCxV3LlmModelSettings", + "properties": { + "model": { + "description": "The selected LLM model.", + "type": "string" + }, + "promptText": { + "description": "The custom prompt to use.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3LoadVersionRequest": { "description": "The request message for Versions.LoadVersion.", "id": "GoogleCloudDialogflowCxV3LoadVersionRequest", @@ -8248,12 +9240,283 @@ }, "type": "object" }, - "GoogleCloudDialogflowCxV3Phrase": { - "description": "Text input which can be used for prompt or banned phrases.", - "id": "GoogleCloudDialogflowCxV3Phrase", + "GoogleCloudDialogflowCxV3Phrase": { + "description": "Text input which can be used for prompt or banned phrases.", + "id": "GoogleCloudDialogflowCxV3Phrase", + "properties": { + "text": { + "description": "Required. Text input which can be used for prompt or banned phrases.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Playbook": { + "description": "Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.", + "id": "GoogleCloudDialogflowCxV3Playbook", + "properties": { + "createTime": { + "description": "Output only. The timestamp of initial playbook creation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the playbook, unique within an agent.", + "type": "string" + }, + "goal": { + "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" + }, + "instruction": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookInstruction", + "description": "Instruction to accomplish target goal." + }, + "llmModelSettings": { + "$ref": "GoogleCloudDialogflowCxV3LlmModelSettings", + "description": "Optional. Llm model settings for the playbook." + }, + "name": { + "description": "The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, + "referencedFlows": { + "description": "Output only. The resource name of flows referenced by the current playbook in the instructions.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "referencedPlaybooks": { + "description": "Output only. The resource name of other playbooks referenced by the current playbook in the instructions.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "referencedTools": { + "description": "Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenCount": { + "description": "Output only. Estimated number of tokes current playbook takes when sent to the LLM.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last time the playbook version was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PlaybookImportStrategy": { + "description": "The playbook import strategy used for resource conflict resolution associated with an ImportPlaybookRequest.", + "id": "GoogleCloudDialogflowCxV3PlaybookImportStrategy", + "properties": { + "mainPlaybookImportStrategy": { + "description": "Optional. Specifies the import strategy used when resolving conflicts with the main playbook. If not specified, 'CREATE_NEW' is assumed.", + "enum": [ + "IMPORT_STRATEGY_UNSPECIFIED", + "IMPORT_STRATEGY_CREATE_NEW", + "IMPORT_STRATEGY_REPLACE", + "IMPORT_STRATEGY_KEEP", + "IMPORT_STRATEGY_MERGE", + "IMPORT_STRATEGY_THROW_ERROR" + ], + "enumDescriptions": [ + "Unspecified. Treated as 'CREATE_NEW'.", + "Create a new resource with a numeric suffix appended to the end of the existing display name.", + "Replace existing resource with incoming resource in the content to be imported.", + "Keep existing resource and discard incoming resource in the content to be imported.", + "Combine existing and incoming resources when a conflict is encountered.", + "Throw error if a conflict is encountered." + ], + "type": "string" + }, + "nestedResourceImportStrategy": { + "description": "Optional. Specifies the import strategy used when resolving referenced playbook/flow conflicts. If not specified, 'CREATE_NEW' is assumed.", + "enum": [ + "IMPORT_STRATEGY_UNSPECIFIED", + "IMPORT_STRATEGY_CREATE_NEW", + "IMPORT_STRATEGY_REPLACE", + "IMPORT_STRATEGY_KEEP", + "IMPORT_STRATEGY_MERGE", + "IMPORT_STRATEGY_THROW_ERROR" + ], + "enumDescriptions": [ + "Unspecified. Treated as 'CREATE_NEW'.", + "Create a new resource with a numeric suffix appended to the end of the existing display name.", + "Replace existing resource with incoming resource in the content to be imported.", + "Keep existing resource and discard incoming resource in the content to be imported.", + "Combine existing and incoming resources when a conflict is encountered.", + "Throw error if a conflict is encountered." + ], + "type": "string" + }, + "toolImportStrategy": { + "description": "Optional. Specifies the import strategy used when resolving tool conflicts. If not specified, 'CREATE_NEW' is assumed. This will be applied after the main playbook and nested resource import strategies, meaning if the playbook that references the tool is skipped, the tool will also be skipped.", + "enum": [ + "IMPORT_STRATEGY_UNSPECIFIED", + "IMPORT_STRATEGY_CREATE_NEW", + "IMPORT_STRATEGY_REPLACE", + "IMPORT_STRATEGY_KEEP", + "IMPORT_STRATEGY_MERGE", + "IMPORT_STRATEGY_THROW_ERROR" + ], + "enumDescriptions": [ + "Unspecified. Treated as 'CREATE_NEW'.", + "Create a new resource with a numeric suffix appended to the end of the existing display name.", + "Replace existing resource with incoming resource in the content to be imported.", + "Keep existing resource and discard incoming resource in the content to be imported.", + "Combine existing and incoming resources when a conflict is encountered.", + "Throw error if a conflict is encountered." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PlaybookInput": { + "description": "Input of the playbook.", + "id": "GoogleCloudDialogflowCxV3PlaybookInput", + "properties": { + "precedingConversationSummary": { + "description": "Optional. Summary string of the preceding conversation for the child playbook invocation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PlaybookInstruction": { + "description": "Message of the Instruction of the playbook.", + "id": "GoogleCloudDialogflowCxV3PlaybookInstruction", + "properties": { + "guidelines": { + "description": "General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. \"Always be polite\". It's valid for this text to be long and used instead of steps altogether.", + "type": "string" + }, + "steps": { + "description": "Ordered list of step by step execution instructions to accomplish target goal.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookStep" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PlaybookInvocation": { + "description": "Stores metadata of the invocation of a child playbook.", + "id": "GoogleCloudDialogflowCxV3PlaybookInvocation", + "properties": { + "displayName": { + "description": "Output only. The display name of the playbook.", + "readOnly": true, + "type": "string" + }, + "playbook": { + "description": "Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, + "playbookInput": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookInput", + "description": "Optional. Input of the child playbook invocation." + }, + "playbookOutput": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookOutput", + "description": "Optional. Output of the child playbook invocation." + }, + "playbookState": { + "description": "Required. Playbook invocation's output state.", + "enum": [ + "OUTPUT_STATE_UNSPECIFIED", + "OUTPUT_STATE_OK", + "OUTPUT_STATE_CANCELLED", + "OUTPUT_STATE_FAILED", + "OUTPUT_STATE_ESCALATED", + "OUTPUT_STATE_PENDING" + ], + "enumDescriptions": [ + "Unspecified output.", + "Succeeded.", + "Cancelled.", + "Failed.", + "Escalated.", + "Pending." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PlaybookOutput": { + "description": "Output of the playbook.", + "id": "GoogleCloudDialogflowCxV3PlaybookOutput", + "properties": { + "executionSummary": { + "description": "Optional. Summary string of the execution result of the child playbook.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PlaybookStep": { + "description": "Message of single step execution.", + "id": "GoogleCloudDialogflowCxV3PlaybookStep", + "properties": { + "steps": { + "description": "Sub-processing needed to execute the current step.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3PlaybookStep" + }, + "type": "array" + }, + "text": { + "description": "Step instruction in text format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PlaybookVersion": { + "description": "Playbook version is a snapshot of the playbook at certain timestamp.", + "id": "GoogleCloudDialogflowCxV3PlaybookVersion", "properties": { - "text": { - "description": "Required. Text input which can be used for prompt or banned phrases.", + "description": { + "description": "Optional. The description of the playbook version.", + "type": "string" + }, + "examples": { + "description": "Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Example" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.", + "type": "string" + }, + "playbook": { + "$ref": "GoogleCloudDialogflowCxV3Playbook", + "description": "Output only. Snapshot of the playbook when the playbook version is created.", + "readOnly": true + }, + "updateTime": { + "description": "Output only. Last time the playbook version was created or modified.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -8286,6 +9549,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3TextInput", "description": "The natural language text to be processed." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResult", + "description": "The results of a tool executed by the client." } }, "type": "object" @@ -8306,6 +9573,10 @@ "description": "The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.", "type": "string" }, + "currentPlaybook": { + "description": "Optional. The unique identifier of the playbook to start or continue the session with. If `current_playbook` is specified, the previous state of the session will be ignored by Dialogflow. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "disableWebhook": { "description": "Whether to disable webhook calls for this request.", "type": "boolean" @@ -8329,6 +9600,10 @@ "$ref": "GoogleTypeLatLng", "description": "The geo location of this conversational query." }, + "llmModelSettings": { + "$ref": "GoogleCloudDialogflowCxV3LlmModelSettings", + "description": "Optional. Use the specified LLM model settings for processing the request." + }, "parameters": { "additionalProperties": { "description": "Properties of the object.", @@ -8571,6 +9846,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText", "description": "Returns a text response." + }, + "toolCall": { + "$ref": "GoogleCloudDialogflowCxV3ToolCall", + "description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -8763,6 +10042,23 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest": { + "description": "The request message for Playbooks.RestorePlaybookVersion.", + "id": "GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RestorePlaybookVersionResponse": { + "description": "The response message for Playbooks.RestorePlaybookVersion.", + "id": "GoogleCloudDialogflowCxV3RestorePlaybookVersionResponse", + "properties": { + "playbook": { + "$ref": "GoogleCloudDialogflowCxV3Playbook", + "description": "The updated playbook." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3RolloutConfig": { "description": "The configuration for auto rollout.", "id": "GoogleCloudDialogflowCxV3RolloutConfig", @@ -8798,621 +10094,1023 @@ "format": "google-duration", "type": "string" }, - "trafficPercent": { - "description": "The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].", + "trafficPercent": { + "description": "The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RolloutState": { + "description": "State of the auto-rollout process.", + "id": "GoogleCloudDialogflowCxV3RolloutState", + "properties": { + "startTime": { + "description": "Start time of the current step.", + "format": "google-datetime", + "type": "string" + }, + "step": { + "description": "Display name of the current auto rollout step.", + "type": "string" + }, + "stepIndex": { + "description": "Index of the current step in the auto rollout steps list.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunContinuousTestMetadata": { + "description": "Metadata returned for the Environments.RunContinuousTest long running operation.", + "id": "GoogleCloudDialogflowCxV3RunContinuousTestMetadata", + "properties": { + "errors": { + "description": "The test errors.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunContinuousTestRequest": { + "description": "The request message for Environments.RunContinuousTest.", + "id": "GoogleCloudDialogflowCxV3RunContinuousTestRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunContinuousTestResponse": { + "description": "The response message for Environments.RunContinuousTest.", + "id": "GoogleCloudDialogflowCxV3RunContinuousTestResponse", + "properties": { + "continuousTestResult": { + "$ref": "GoogleCloudDialogflowCxV3ContinuousTestResult", + "description": "The result for a continuous test run." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseMetadata": { + "description": "Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseRequest": { + "description": "The request message for TestCases.RunTestCase.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseRequest", + "properties": { + "environment": { + "description": "Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseResponse": { + "description": "The response message for TestCases.RunTestCase.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseResponse", + "properties": { + "result": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", + "description": "The result." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SafetySettings": { + "description": "Settings for Generative Safety.", + "id": "GoogleCloudDialogflowCxV3SafetySettings", + "properties": { + "bannedPhrases": { + "description": "Banned phrases for generated text.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3SafetySettingsPhrase" + }, + "type": "array" + }, + "defaultBannedPhraseMatchStrategy": { + "description": "Optional. Default phrase match strategy for banned phrases.", + "enum": [ + "PHRASE_MATCH_STRATEGY_UNSPECIFIED", + "PARTIAL_MATCH", + "WORD_MATCH" + ], + "enumDescriptions": [ + "Unspecified, defaults to PARTIAL_MATCH.", + "Text that contains the phrase as a substring will be matched, e.g. \"foo\" will match \"afoobar\".", + "Text that contains the tokenized words of the phrase will be matched, e.g. \"foo\" will match \"a foo bar\" and \"foo bar\", but not \"foobar\"." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SafetySettingsPhrase": { + "description": "Text input which can be used for prompt or banned phrases.", + "id": "GoogleCloudDialogflowCxV3SafetySettingsPhrase", + "properties": { + "languageCode": { + "description": "Required. Language code of the phrase.", + "type": "string" + }, + "text": { + "description": "Required. Text input which can be used for prompt or banned phrases.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SearchConfig": { + "description": "Search configuration for UCS search queries.", + "id": "GoogleCloudDialogflowCxV3SearchConfig", + "properties": { + "boostSpecs": { + "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. 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" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SecuritySettings": { + "description": "Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.", + "id": "GoogleCloudDialogflowCxV3SecuritySettings", + "properties": { + "audioExportSettings": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings", + "description": "Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent." + }, + "deidentifyTemplate": { + "description": "[DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. The `DLP De-identify Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, Dialogflow replaces sensitive info with `[redacted]` text. The template name will have one of the following formats: `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the security settings, unique within the location.", + "type": "string" + }, + "insightsExportSettings": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings", + "description": "Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here." + }, + "inspectTemplate": { + "description": "[DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. The `DLP Inspect Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//locations//inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `inspect_template` must be located in the same region as the `SecuritySettings`.", + "type": "string" + }, + "name": { + "description": "Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`.", + "type": "string" + }, + "purgeDataTypes": { + "description": "List of types of data to remove when retention settings triggers purge.", + "items": { + "enum": [ + "PURGE_DATA_TYPE_UNSPECIFIED", + "DIALOGFLOW_HISTORY" + ], + "enumDescriptions": [ + "Unspecified. Do not use.", + "Dialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow." + ], + "type": "string" + }, + "type": "array" + }, + "redactionScope": { + "description": "Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.", + "enum": [ + "REDACTION_SCOPE_UNSPECIFIED", + "REDACT_DISK_STORAGE" + ], + "enumDescriptions": [ + "Don't redact any kind of data.", + "On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk." + ], + "type": "string" + }, + "redactionStrategy": { + "description": "Strategy that defines how we do redaction.", + "enum": [ + "REDACTION_STRATEGY_UNSPECIFIED", + "REDACT_WITH_SERVICE" + ], + "enumDescriptions": [ + "Do not redact.", + "Call redaction service to clean up the data to be persisted." + ], + "type": "string" + }, + "retentionStrategy": { + "description": "Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.", + "enum": [ + "RETENTION_STRATEGY_UNSPECIFIED", + "REMOVE_AFTER_CONVERSATION" + ], + "enumDescriptions": [ + "Retains the persisted data with Dialogflow's internal default 365d TTLs.", + "Removes data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends." + ], + "type": "string" + }, + "retentionWindowDays": { + "description": "Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3RolloutState": { - "description": "State of the auto-rollout process.", - "id": "GoogleCloudDialogflowCxV3RolloutState", + "GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings": { + "description": "Settings for exporting audio.", + "id": "GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings", "properties": { - "startTime": { - "description": "Start time of the current step.", - "format": "google-datetime", + "audioExportPattern": { + "description": "Filename pattern for exported audio.", "type": "string" }, - "step": { - "description": "Display name of the current auto rollout step.", + "audioFormat": { + "description": "File format for exported audio file. Currently only in telephony recordings.", + "enum": [ + "AUDIO_FORMAT_UNSPECIFIED", + "MULAW", + "MP3", + "OGG" + ], + "enumDescriptions": [ + "Unspecified. Do not use.", + "G.711 mu-law PCM with 8kHz sample rate.", + "MP3 file format.", + "OGG Vorbis." + ], "type": "string" }, - "stepIndex": { - "description": "Index of the current step in the auto rollout steps list.", - "format": "int32", - "type": "integer" + "enableAudioRedaction": { + "description": "Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted.", + "type": "boolean" + }, + "gcsBucket": { + "description": "Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.", + "type": "string" + }, + "storeTtsAudio": { + "description": "Whether to store TTS audio. By default, TTS audio from the virtual agent is not exported.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3RunContinuousTestMetadata": { - "description": "Metadata returned for the Environments.RunContinuousTest long running operation.", - "id": "GoogleCloudDialogflowCxV3RunContinuousTestMetadata", + "GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings": { + "description": "Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs).", + "id": "GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings", "properties": { - "errors": { - "description": "The test errors.", - "items": { - "$ref": "GoogleCloudDialogflowCxV3TestError" - }, - "type": "array" + "enableInsightsExport": { + "description": "If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3RunContinuousTestRequest": { - "description": "The request message for Environments.RunContinuousTest.", - "id": "GoogleCloudDialogflowCxV3RunContinuousTestRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowCxV3RunContinuousTestResponse": { - "description": "The response message for Environments.RunContinuousTest.", - "id": "GoogleCloudDialogflowCxV3RunContinuousTestResponse", + "GoogleCloudDialogflowCxV3SentimentAnalysisResult": { + "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.", + "id": "GoogleCloudDialogflowCxV3SentimentAnalysisResult", "properties": { - "continuousTestResult": { - "$ref": "GoogleCloudDialogflowCxV3ContinuousTestResult", - "description": "The result for a continuous test run." + "magnitude": { + "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", + "format": "float", + "type": "number" + }, + "score": { + "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3RunTestCaseMetadata": { - "description": "Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.", - "id": "GoogleCloudDialogflowCxV3RunTestCaseMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowCxV3RunTestCaseRequest": { - "description": "The request message for TestCases.RunTestCase.", - "id": "GoogleCloudDialogflowCxV3RunTestCaseRequest", + "GoogleCloudDialogflowCxV3SessionEntityType": { + "description": "Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as \"custom entity types\"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).", + "id": "GoogleCloudDialogflowCxV3SessionEntityType", "properties": { - "environment": { - "description": "Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.", + "entities": { + "description": "Required. The collection of entities to override or supplement the custom entity type.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EntityTypeEntity" + }, + "type": "array" + }, + "entityOverrideMode": { + "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", + "enum": [ + "ENTITY_OVERRIDE_MODE_UNSPECIFIED", + "ENTITY_OVERRIDE_MODE_OVERRIDE", + "ENTITY_OVERRIDE_MODE_SUPPLEMENT" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", + "The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge." + ], + "type": "string" + }, + "name": { + "description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3RunTestCaseResponse": { - "description": "The response message for TestCases.RunTestCase.", - "id": "GoogleCloudDialogflowCxV3RunTestCaseResponse", + "GoogleCloudDialogflowCxV3SessionInfo": { + "description": "Represents session information communicated to and from the webhook.", + "id": "GoogleCloudDialogflowCxV3SessionInfo", "properties": { - "result": { - "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", - "description": "The result." + "parameters": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", + "type": "object" + }, + "session": { + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SafetySettings": { - "description": "Settings for Generative Safety.", - "id": "GoogleCloudDialogflowCxV3SafetySettings", + "GoogleCloudDialogflowCxV3SpeechToTextSettings": { + "description": "Settings related to speech recognition.", + "id": "GoogleCloudDialogflowCxV3SpeechToTextSettings", "properties": { - "bannedPhrases": { - "description": "Banned phrases for generated text.", - "items": { - "$ref": "GoogleCloudDialogflowCxV3SafetySettingsPhrase" - }, - "type": "array" + "enableSpeechAdaptation": { + "description": "Whether to use speech adaptation for speech recognition.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SafetySettingsPhrase": { - "description": "Text input which can be used for prompt or banned phrases.", - "id": "GoogleCloudDialogflowCxV3SafetySettingsPhrase", + "GoogleCloudDialogflowCxV3StartExperimentRequest": { + "description": "The request message for Experiments.StartExperiment.", + "id": "GoogleCloudDialogflowCxV3StartExperimentRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3StopExperimentRequest": { + "description": "The request message for Experiments.StopExperiment.", + "id": "GoogleCloudDialogflowCxV3StopExperimentRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest": { + "description": "The request to set the feedback for a bot answer.", + "id": "GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest", "properties": { - "languageCode": { - "description": "Required. Language code of the phrase.", + "answerFeedback": { + "$ref": "GoogleCloudDialogflowCxV3AnswerFeedback", + "description": "Required. Feedback provided for a bot answer." + }, + "responseId": { + "description": "Required. ID of the response to update its feedback. This is the same as DetectIntentResponse.response_id.", "type": "string" }, - "text": { - "description": "Required. Text input which can be used for prompt or banned phrases.", + "updateMask": { + "description": "Optional. The mask to control which fields to update. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SearchConfig": { - "description": "Search configuration for UCS search queries.", - "id": "GoogleCloudDialogflowCxV3SearchConfig", + "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig": { + "description": "Configuration of how speech should be synthesized.", + "id": "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig", "properties": { - "boostSpecs": { - "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.", + "effectsProfileId": { + "description": "Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.", "items": { - "$ref": "GoogleCloudDialogflowCxV3BoostSpecs" + "type": "string" }, "type": "array" }, - "filterSpecs": { - "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" - }, - "type": "array" + "pitch": { + "description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.", + "format": "double", + "type": "number" + }, + "speakingRate": { + "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", + "format": "double", + "type": "number" + }, + "voice": { + "$ref": "GoogleCloudDialogflowCxV3VoiceSelectionParams", + "description": "Optional. The desired voice of the synthesized audio." + }, + "volumeGainDb": { + "description": "Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SecuritySettings": { - "description": "Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.", - "id": "GoogleCloudDialogflowCxV3SecuritySettings", + "GoogleCloudDialogflowCxV3TestCase": { + "description": "Represents a test case.", + "id": "GoogleCloudDialogflowCxV3TestCase", "properties": { - "audioExportSettings": { - "$ref": "GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings", - "description": "Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent." - }, - "deidentifyTemplate": { - "description": "[DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. The `DLP De-identify Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, Dialogflow replaces sensitive info with `[redacted]` text. The template name will have one of the following formats: `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`.", - "type": "string" - }, - "displayName": { - "description": "Required. The human-readable name of the security settings, unique within the location.", + "creationTime": { + "description": "Output only. When the test was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "insightsExportSettings": { - "$ref": "GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings", - "description": "Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here." - }, - "inspectTemplate": { - "description": "[DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. The `DLP Inspect Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//locations//inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `inspect_template` must be located in the same region as the `SecuritySettings`.", + "displayName": { + "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", "type": "string" }, + "lastTestResult": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", + "description": "The latest test result." + }, "name": { - "description": "Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, - "purgeDataTypes": { - "description": "List of types of data to remove when retention settings triggers purge.", + "notes": { + "description": "Additional freeform notes about the test case. Limit of 400 characters.", + "type": "string" + }, + "tags": { + "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", "items": { - "enum": [ - "PURGE_DATA_TYPE_UNSPECIFIED", - "DIALOGFLOW_HISTORY" - ], - "enumDescriptions": [ - "Unspecified. Do not use.", - "Dialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow." - ], "type": "string" }, "type": "array" }, - "redactionScope": { - "description": "Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.", - "enum": [ - "REDACTION_SCOPE_UNSPECIFIED", - "REDACT_DISK_STORAGE" - ], - "enumDescriptions": [ - "Don't redact any kind of data.", - "On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk." - ], - "type": "string" - }, - "redactionStrategy": { - "description": "Strategy that defines how we do redaction.", - "enum": [ - "REDACTION_STRATEGY_UNSPECIFIED", - "REDACT_WITH_SERVICE" - ], - "enumDescriptions": [ - "Do not redact.", - "Call redaction service to clean up the data to be persisted." - ], - "type": "string" + "testCaseConversationTurns": { + "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" + }, + "type": "array" }, - "retentionStrategy": { - "description": "Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.", - "enum": [ - "RETENTION_STRATEGY_UNSPECIFIED", - "REMOVE_AFTER_CONVERSATION" - ], - "enumDescriptions": [ - "Retains the persisted data with Dialogflow's internal default 365d TTLs.", - "Removes data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends." - ], - "type": "string" + "testConfig": { + "$ref": "GoogleCloudDialogflowCxV3TestConfig", + "description": "Config for the test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestCaseError": { + "description": "Error info for importing a test.", + "id": "GoogleCloudDialogflowCxV3TestCaseError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test case." }, - "retentionWindowDays": { - "description": "Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. When data retention configuration is changed, it only applies to the data created after the change; the TTL of existing data created before the change stays intact.", - "format": "int32", - "type": "integer" + "testCase": { + "$ref": "GoogleCloudDialogflowCxV3TestCase", + "description": "The test case." } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings": { - "description": "Settings for exporting audio.", - "id": "GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings", + "GoogleCloudDialogflowCxV3TestCaseResult": { + "description": "Represents a result from running a test case in an agent environment.", + "id": "GoogleCloudDialogflowCxV3TestCaseResult", "properties": { - "audioExportPattern": { - "description": "Filename pattern for exported audio.", + "conversationTurns": { + "description": "The conversation turns uttered during the test case replay in chronological order.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" + }, + "type": "array" + }, + "environment": { + "description": "Environment where the test was run. If not set, it indicates the draft environment.", "type": "string" }, - "audioFormat": { - "description": "File format for exported audio file. Currently only in telephony recordings.", + "name": { + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", + "type": "string" + }, + "testResult": { + "description": "Whether the test case passed in the agent environment.", "enum": [ - "AUDIO_FORMAT_UNSPECIFIED", - "MULAW", - "MP3", - "OGG" + "TEST_RESULT_UNSPECIFIED", + "PASSED", + "FAILED" ], "enumDescriptions": [ - "Unspecified. Do not use.", - "G.711 mu-law PCM with 8kHz sample rate.", - "MP3 file format.", - "OGG Vorbis." + "Not specified. Should never be used.", + "The test passed.", + "The test did not pass." ], "type": "string" }, - "enableAudioRedaction": { - "description": "Enable audio redaction if it is true. Note that this only redacts end-user audio data; Synthesised audio from the virtual agent is not redacted.", - "type": "boolean" - }, - "gcsBucket": { - "description": "Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.", + "testTime": { + "description": "The time that the test was run.", + "format": "google-datetime", "type": "string" - }, - "storeTtsAudio": { - "description": "Whether to store TTS audio. By default, TTS audio from the virtual agent is not exported.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings": { - "description": "Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs).", - "id": "GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings", + "GoogleCloudDialogflowCxV3TestConfig": { + "description": "Represents configurations for a test case.", + "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { - "enableInsightsExport": { - "description": "If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.", - "type": "boolean" + "flow": { + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", + "type": "string" + }, + "page": { + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", + "type": "string" + }, + "trackingParameters": { + "description": "Session parameters to be compared when calculating differences.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SentimentAnalysisResult": { - "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.", - "id": "GoogleCloudDialogflowCxV3SentimentAnalysisResult", + "GoogleCloudDialogflowCxV3TestError": { + "description": "Error info for running a test.", + "id": "GoogleCloudDialogflowCxV3TestError", "properties": { - "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", - "format": "float", - "type": "number" + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test." }, - "score": { - "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", - "format": "float", - "type": "number" + "testCase": { + "description": "The test case resource name.", + "type": "string" + }, + "testTime": { + "description": "The timestamp when the test was completed.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SessionEntityType": { - "description": "Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as \"custom entity types\"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).", - "id": "GoogleCloudDialogflowCxV3SessionEntityType", + "GoogleCloudDialogflowCxV3TestRunDifference": { + "description": "The description of differences between original and replayed agent output.", + "id": "GoogleCloudDialogflowCxV3TestRunDifference", "properties": { - "entities": { - "description": "Required. The collection of entities to override or supplement the custom entity type.", - "items": { - "$ref": "GoogleCloudDialogflowCxV3EntityTypeEntity" - }, - "type": "array" + "description": { + "description": "A human readable description of the diff, showing the actual output vs expected output.", + "type": "string" }, - "entityOverrideMode": { - "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", + "type": { + "description": "The type of diff.", "enum": [ - "ENTITY_OVERRIDE_MODE_UNSPECIFIED", - "ENTITY_OVERRIDE_MODE_OVERRIDE", - "ENTITY_OVERRIDE_MODE_SUPPLEMENT" + "DIFF_TYPE_UNSPECIFIED", + "INTENT", + "PAGE", + "PARAMETERS", + "UTTERANCE", + "FLOW" ], "enumDescriptions": [ - "Not specified. This value should be never used.", - "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", - "The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge." + "Should never be used.", + "The intent.", + "The page.", + "The parameters.", + "The message utterance.", + "The flow." ], "type": "string" - }, - "name": { - "description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SessionInfo": { - "description": "Represents session information communicated to and from the webhook.", - "id": "GoogleCloudDialogflowCxV3SessionInfo", + "GoogleCloudDialogflowCxV3TextInput": { + "description": "Represents the natural language text to be processed.", + "id": "GoogleCloudDialogflowCxV3TextInput", "properties": { - "parameters": { - "additionalProperties": { - "type": "any" - }, - "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", - "type": "object" - }, - "session": { - "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", + "text": { + "description": "Required. The UTF-8 encoded natural language text to be processed.", "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SpeechToTextSettings": { - "description": "Settings related to speech recognition.", - "id": "GoogleCloudDialogflowCxV3SpeechToTextSettings", + "GoogleCloudDialogflowCxV3TextToSpeechSettings": { + "description": "Settings related to speech synthesizing.", + "id": "GoogleCloudDialogflowCxV3TextToSpeechSettings", "properties": { - "enableSpeechAdaptation": { - "description": "Whether to use speech adaptation for speech recognition.", - "type": "boolean" + "synthesizeSpeechConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig" + }, + "description": "Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3StartExperimentRequest": { - "description": "The request message for Experiments.StartExperiment.", - "id": "GoogleCloudDialogflowCxV3StartExperimentRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowCxV3StopExperimentRequest": { - "description": "The request message for Experiments.StopExperiment.", - "id": "GoogleCloudDialogflowCxV3StopExperimentRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest": { - "description": "The request to set the feedback for a bot answer.", - "id": "GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest", + "GoogleCloudDialogflowCxV3Tool": { + "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": "GoogleCloudDialogflowCxV3Tool", "properties": { - "answerFeedback": { - "$ref": "GoogleCloudDialogflowCxV3AnswerFeedback", - "description": "Required. Feedback provided for a bot answer." + "dataStoreSpec": { + "$ref": "GoogleCloudDialogflowCxV3ToolDataStoreTool", + "description": "Data store search tool specification." }, - "responseId": { - "description": "Required. ID of the response to update its feedback. This is the same as DetectIntentResponse.response_id.", + "description": { + "description": "Required. High level description of the Tool and its usage.", "type": "string" }, - "updateMask": { - "description": "Optional. The mask to control which fields to update. If the mask is not present, all fields will be updated.", - "format": "google-fieldmask", + "displayName": { + "description": "Required. The human-readable name of the Tool, unique within an agent.", + "type": "string" + }, + "functionSpec": { + "$ref": "GoogleCloudDialogflowCxV3ToolFunctionTool", + "description": "Client side executed function specification." + }, + "name": { + "description": "The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.", + "type": "string" + }, + "openApiSpec": { + "$ref": "GoogleCloudDialogflowCxV3ToolOpenApiTool", + "description": "OpenAPI specification of the Tool." + }, + "toolType": { + "description": "Output only. The tool type.", + "enum": [ + "TOOL_TYPE_UNSPECIFIED", + "CUSTOMIZED_TOOL", + "BUILTIN_TOOL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Customer provided tool.", + "First party built-in tool created by Dialogflow which cannot be modified." + ], + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig": { - "description": "Configuration of how speech should be synthesized.", - "id": "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig", + "GoogleCloudDialogflowCxV3ToolAuthentication": { + "description": "Authentication information required for API calls", + "id": "GoogleCloudDialogflowCxV3ToolAuthentication", "properties": { - "effectsProfileId": { - "description": "Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.", - "items": { - "type": "string" - }, - "type": "array" - }, - "pitch": { - "description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.", - "format": "double", - "type": "number" + "apiKeyConfig": { + "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig", + "description": "Config for API key auth." }, - "speakingRate": { - "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", - "format": "double", - "type": "number" + "bearerTokenConfig": { + "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig", + "description": "Config for bearer token auth." }, - "voice": { - "$ref": "GoogleCloudDialogflowCxV3VoiceSelectionParams", - "description": "Optional. The desired voice of the synthesized audio." + "oauthConfig": { + "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig", + "description": "Config for OAuth." }, - "volumeGainDb": { - "description": "Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.", - "format": "double", - "type": "number" + "serviceAgentAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig", + "description": "Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth." } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TestCase": { - "description": "Represents a test case.", - "id": "GoogleCloudDialogflowCxV3TestCase", + "GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig": { + "description": "Config for authentication with API key.", + "id": "GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig", "properties": { - "creationTime": { - "description": "Output only. When the test was created.", - "format": "google-datetime", - "readOnly": true, + "apiKey": { + "description": "Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.", "type": "string" }, - "displayName": { - "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", + "keyName": { + "description": "Required. The parameter name or the header name of the API key. E.g., If the API request is \"https://example.com/act?X-Api-Key=\", \"X-Api-Key\" would be the parameter name.", "type": "string" }, - "lastTestResult": { - "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", - "description": "The latest test result." - }, - "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", + "requestLocation": { + "description": "Required. Key location in the request.", + "enum": [ + "REQUEST_LOCATION_UNSPECIFIED", + "HEADER", + "QUERY_STRING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Represents the key in http header.", + "Represents the key in query string." + ], "type": "string" }, - "notes": { - "description": "Additional freeform notes about the test case. Limit of 400 characters.", + "secretVersionForApiKey": { + "description": "Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", "type": "string" - }, - "tags": { - "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", - "items": { - "type": "string" - }, - "type": "array" - }, - "testCaseConversationTurns": { - "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", - "items": { - "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" - }, - "type": "array" - }, - "testConfig": { - "$ref": "GoogleCloudDialogflowCxV3TestConfig", - "description": "Config for the test case." } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TestCaseError": { - "description": "Error info for importing a test.", - "id": "GoogleCloudDialogflowCxV3TestCaseError", + "GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig": { + "description": "Config for authentication using bearer token.", + "id": "GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig", "properties": { - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status associated with the test case." + "secretVersionForToken": { + "description": "Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" }, - "testCase": { - "$ref": "GoogleCloudDialogflowCxV3TestCase", - "description": "The test case." + "token": { + "description": "Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TestCaseResult": { - "description": "Represents a result from running a test case in an agent environment.", - "id": "GoogleCloudDialogflowCxV3TestCaseResult", + "GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig": { + "description": "Config for authentication with OAuth.", + "id": "GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig", "properties": { - "conversationTurns": { - "description": "The conversation turns uttered during the test case replay in chronological order.", + "clientId": { + "description": "Required. The client ID from the OAuth provider.", + "type": "string" + }, + "clientSecret": { + "description": "Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored.", + "type": "string" + }, + "oauthGrantType": { + "description": "Required. OAuth grant types.", + "enum": [ + "OAUTH_GRANT_TYPE_UNSPECIFIED", + "CLIENT_CREDENTIAL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Represents the [client credential flow](https://oauth.net/2/grant-types/client-credentials)." + ], + "type": "string" + }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", "items": { - "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" + "type": "string" }, "type": "array" }, - "environment": { - "description": "Environment where the test was run. If not set, it indicates the draft environment.", + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", "type": "string" }, - "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", + "tokenEndpoint": { + "description": "Required. The token endpoint in the OAuth provider to exchange for an access token.", "type": "string" - }, - "testResult": { - "description": "Whether the test case passed in the agent environment.", + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig": { + "description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "id": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig", + "properties": { + "serviceAgentAuth": { + "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ - "TEST_RESULT_UNSPECIFIED", - "PASSED", - "FAILED" + "SERVICE_AGENT_AUTH_UNSPECIFIED", + "ID_TOKEN", + "ACCESS_TOKEN" ], "enumDescriptions": [ - "Not specified. Should never be used.", - "The test passed.", - "The test did not pass." + "Service agent auth type unspecified. Default to ID_TOKEN.", + "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", + "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." ], "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowCxV3ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" }, - "testTime": { - "description": "The time that the test was run.", - "format": "google-datetime", + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TestConfig": { - "description": "Represents configurations for a test case.", - "id": "GoogleCloudDialogflowCxV3TestConfig", + "GoogleCloudDialogflowCxV3ToolCallResult": { + "description": "The result of calling a tool's action that has been executed by the client.", + "id": "GoogleCloudDialogflowCxV3ToolCallResult", "properties": { - "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", + "action": { + "description": "Required. The name of the tool's action associated with this call.", "type": "string" }, - "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", - "type": "string" + "error": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResultError", + "description": "The tool call's error." }, - "trackingParameters": { - "description": "Session parameters to be compared when calculating differences.", + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The tool call's output parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowCxV3ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolDataStoreTool": { + "description": "A DataStoreTool is a way to provide specifications needed to search a list of data stores.", + "id": "GoogleCloudDialogflowCxV3ToolDataStoreTool", + "properties": { + "dataStoreConnections": { + "description": "Required. List of data stores to search.", "items": { - "type": "string" + "$ref": "GoogleCloudDialogflowCxV3DataStoreConnection" }, "type": "array" + }, + "fallbackPrompt": { + "$ref": "GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt", + "description": "Required. Fallback prompt configurations to use." } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TestError": { - "description": "Error info for running a test.", - "id": "GoogleCloudDialogflowCxV3TestError", + "GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt": { + "description": "A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses.", + "id": "GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolFunctionTool": { + "description": "A Function tool describes the functions to be invoked on the client side.", + "id": "GoogleCloudDialogflowCxV3ToolFunctionTool", "properties": { - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status associated with the test." + "inputSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.", + "type": "object" + }, + "outputSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolOpenApiTool": { + "description": "An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format.", + "id": "GoogleCloudDialogflowCxV3ToolOpenApiTool", + "properties": { + "authentication": { + "$ref": "GoogleCloudDialogflowCxV3ToolAuthentication", + "description": "Optional. Authentication information required by the API." }, - "testCase": { - "description": "The test case resource name.", - "type": "string" + "serviceDirectoryConfig": { + "$ref": "GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig", + "description": "Optional. Service Directory configuration." }, - "testTime": { - "description": "The timestamp when the test was completed.", - "format": "google-datetime", + "textSchema": { + "description": "Required. The OpenAPI schema specified as a text.", "type": "string" + }, + "tlsConfig": { + "$ref": "GoogleCloudDialogflowCxV3ToolTLSConfig", + "description": "Optional. TLS configuration for the HTTPS verification." } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TestRunDifference": { - "description": "The description of differences between original and replayed agent output.", - "id": "GoogleCloudDialogflowCxV3TestRunDifference", + "GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig": { + "description": "Configuration for tools using Service Directory.", + "id": "GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig", "properties": { - "description": { - "description": "A human readable description of the diff, showing the actual output vs expected output.", - "type": "string" - }, - "type": { - "description": "The type of diff.", - "enum": [ - "DIFF_TYPE_UNSPECIFIED", - "INTENT", - "PAGE", - "PARAMETERS", - "UTTERANCE", - "FLOW" - ], - "enumDescriptions": [ - "Should never be used.", - "The intent.", - "The page.", - "The parameters.", - "The message utterance.", - "The flow." - ], + "service": { + "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the agent.", "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TextInput": { - "description": "Represents the natural language text to be processed.", - "id": "GoogleCloudDialogflowCxV3TextInput", + "GoogleCloudDialogflowCxV3ToolTLSConfig": { + "description": "The TLS configuration.", + "id": "GoogleCloudDialogflowCxV3ToolTLSConfig", "properties": { - "text": { - "description": "Required. The UTF-8 encoded natural language text to be processed.", + "caCerts": { + "description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ToolTLSConfigCACert" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolTLSConfigCACert": { + "description": "The CA certificate.", + "id": "GoogleCloudDialogflowCxV3ToolTLSConfigCACert", + "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'\") ```", + "format": "byte", + "type": "string" + }, + "displayName": { + "description": "Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.", "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowCxV3TextToSpeechSettings": { - "description": "Settings related to speech synthesizing.", - "id": "GoogleCloudDialogflowCxV3TextToSpeechSettings", + "GoogleCloudDialogflowCxV3ToolUse": { + "description": "Stores metadata of the invocation of an action supported by a tool.", + "id": "GoogleCloudDialogflowCxV3ToolUse", "properties": { - "synthesizeSpeechConfigs": { + "action": { + "description": "Optional. Name of the action to be called during the tool use.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the tool.", + "readOnly": true, + "type": "string" + }, + "inputActionParameters": { "additionalProperties": { - "$ref": "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig" + "description": "Properties of the object.", + "type": "any" }, - "description": "Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.", + "description": "Optional. A list of input parameters for the action.", + "type": "object" + }, + "outputActionParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. A list of output parameters generated by the action.", "type": "object" + }, + "tool": { + "description": "Required. The tool that should be used. Format: `projects//locations//agents//tools/`.", + "type": "string" } }, "type": "object" @@ -9669,6 +11367,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3UserUtterance": { + "description": "UserUtterance represents one message sent by the customer.", + "id": "GoogleCloudDialogflowCxV3UserUtterance", + "properties": { + "text": { + "description": "Required. Message content in text.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ValidateAgentRequest": { "description": "The request message for Agents.ValidateAgent.", "id": "GoogleCloudDialogflowCxV3ValidateAgentRequest", @@ -9990,6 +11699,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -10051,6 +11771,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -10058,6 +11782,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -12365,6 +14100,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -12426,6 +14172,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -12433,6 +14183,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", @@ -13330,6 +15091,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -15068,6 +16851,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "description": "Metadata for a ConversationModels.UndeployConversationModel operation.", "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", @@ -15621,6 +17478,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -17615,15 +19494,15 @@ "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", - "DTMF_DIGITS", "END_OF_SINGLE_UTTERANCE", + "DTMF_DIGITS", "PARTIAL_DTMF_DIGITS" ], "enumDescriptions": [ "Not specified. Should never be used.", "Message contains a (possibly partial) transcript.", - "Message contains DTMF digits.", "This event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if `single_utterance` was set to `true`, and is not used otherwise.", + "Message contains DTMF digits.", "Message contains DTMF digits. Before a message with DTMF_DIGITS is sent, a message with PARTIAL_DTMF_DIGITS may be sent with DTMF digits collected up to the time of sending, which represents an intermediate result." ], "type": "string" @@ -17885,6 +19764,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2beta1ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1WebhookRequest": { "description": "The request message for a webhook call.", "id": "GoogleCloudDialogflowV2beta1WebhookRequest", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index cc9b2c32668..17c76effd0b 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -147,6 +147,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -3188,6 +3194,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "export": { + "description": "Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}:export", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.playbooks.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the playbook to export. Format: `projects//locations//agents//playbooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+name}:export", + "request": { + "$ref": "GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "get": { "description": "Retrieves the specified Playbook.", "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}", @@ -3214,6 +3249,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "import": { + "description": "Imports the specified playbook to the specified agent from a binary file.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks:import", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.playbooks.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to import the playbook into. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+parent}/playbooks:import", + "request": { + "$ref": "GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns a list of playbooks in the specified agent.", "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks", @@ -3569,6 +3633,35 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ] + }, + "restore": { + "description": "Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}:restore", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.playbooks.versions.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+name}:restore", + "request": { + "$ref": "GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] } } } @@ -5343,7 +5436,7 @@ } } }, - "revision": "20250313", + "revision": "20250422", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -6715,6 +6808,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3TextInput", "description": "The natural language text to be processed." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResult", + "description": "The results of a tool executed by the client." } }, "type": "object" @@ -6788,6 +6885,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText", "description": "Returns a text response." + }, + "toolCall": { + "$ref": "GoogleCloudDialogflowCxV3ToolCall", + "description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -7182,6 +7283,67 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowCxV3ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCallResult": { + "description": "The result of calling a tool's action that has been executed by the client.", + "id": "GoogleCloudDialogflowCxV3ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowCxV3ToolCallResultError", + "description": "The tool call's error." + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The tool call's output parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowCxV3ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3TransitionRoute", @@ -7378,6 +7540,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -7439,6 +7612,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -7446,6 +7623,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -7676,6 +7864,17 @@ "$ref": "GoogleCloudDialogflowCxV3beta1AgentUtterance", "description": "Optional. Action performed by the agent as a message." }, + "completeTime": { + "description": "Output only. Timestamp of the completion of the agent action.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the action.", + "readOnly": true, + "type": "string" + }, "event": { "$ref": "GoogleCloudDialogflowCxV3beta1Event", "description": "Optional. The agent received an event from the customer or a system event is emitted." @@ -7684,10 +7883,25 @@ "$ref": "GoogleCloudDialogflowCxV3beta1FlowInvocation", "description": "Optional. Action performed on behalf of the agent by invoking a CX flow." }, + "flowStateUpdate": { + "$ref": "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate", + "description": "Optional. Output only. The state machine update in flows.", + "readOnly": true + }, "flowTransition": { "$ref": "GoogleCloudDialogflowCxV3beta1FlowTransition", "description": "Optional. Action performed on behalf of the agent by transitioning to a target CX flow." }, + "intentMatch": { + "$ref": "GoogleCloudDialogflowCxV3beta1ActionIntentMatch", + "description": "Optional. Output only. Intent Match in flows.", + "readOnly": true + }, + "llmCall": { + "$ref": "GoogleCloudDialogflowCxV3beta1LlmCall", + "description": "Optional. Output only. LLM call performed by the agent.", + "readOnly": true + }, "playbookInvocation": { "$ref": "GoogleCloudDialogflowCxV3beta1PlaybookInvocation", "description": "Optional. Action performed on behalf of the agent by invoking a child playbook." @@ -7696,10 +7910,36 @@ "$ref": "GoogleCloudDialogflowCxV3beta1PlaybookTransition", "description": "Optional. Action performed on behalf of the agent by transitioning to a target playbook." }, + "startTime": { + "description": "Output only. Timestamp of the start of the agent action.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "GoogleCloudDialogflowCxV3beta1Status", + "description": "Optional. Output only. The status of the action.", + "readOnly": true + }, + "stt": { + "$ref": "GoogleCloudDialogflowCxV3beta1ActionSTT", + "description": "Optional. Speech-to-text action performed by the agent." + }, + "subExecutionSteps": { + "description": "Optional. The detailed tracing information for sub execution steps of the action.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1Span" + }, + "type": "array" + }, "toolUse": { "$ref": "GoogleCloudDialogflowCxV3beta1ToolUse", "description": "Optional. Action performed on behalf of the agent by calling a plugin tool." }, + "tts": { + "$ref": "GoogleCloudDialogflowCxV3beta1ActionTTS", + "description": "Optional. Text-to-speech action performed by the agent." + }, "userUtterance": { "$ref": "GoogleCloudDialogflowCxV3beta1UserUtterance", "description": "Optional. Agent obtained a message from the customer." @@ -7707,6 +7947,121 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate": { + "description": "Stores metadata of the state update action, such as a state machine execution in flows.", + "id": "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate", + "properties": { + "destination": { + "description": "The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.", + "type": "string" + }, + "eventType": { + "description": "The type of the event that triggered the state update.", + "type": "string" + }, + "functionCall": { + "$ref": "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdateFunctionCall", + "description": "The function call to execute." + }, + "pageState": { + "$ref": "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdatePageState", + "description": "The updated page and flow state." + }, + "updatedParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The updated parameters.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdateFunctionCall": { + "description": "Stores the metadata of a function call to execute.", + "id": "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdateFunctionCall", + "properties": { + "name": { + "description": "The name of the function call.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdatePageState": { + "description": "Stores the state of a page and its flow.", + "id": "GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdatePageState", + "properties": { + "displayName": { + "description": "The display name of the page.", + "type": "string" + }, + "page": { + "description": "The ID of the page. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "status": { + "description": "The status of the page.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ActionIntentMatch": { + "description": "Stores metadata of the intent match action.", + "id": "GoogleCloudDialogflowCxV3beta1ActionIntentMatch", + "properties": { + "matchedIntents": { + "description": "The matched intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ActionIntentMatchMatchedIntent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ActionIntentMatchMatchedIntent": { + "description": "Stores the matched intent, which is the result of the intent match action.", + "id": "GoogleCloudDialogflowCxV3beta1ActionIntentMatchMatchedIntent", + "properties": { + "displayName": { + "description": "The display name of the matched intent.", + "type": "string" + }, + "generativeFallback": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The generative fallback response of the matched intent.", + "type": "object" + }, + "intentId": { + "description": "The ID of the matched intent.", + "type": "string" + }, + "score": { + "description": "The score of the matched intent.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ActionSTT": { + "description": "Stores metadata of the Speech-to-Text action.", + "id": "GoogleCloudDialogflowCxV3beta1ActionSTT", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ActionTTS": { + "description": "Stores metadata of the Text-to-Speech action.", + "id": "GoogleCloudDialogflowCxV3beta1ActionTTS", + "properties": {}, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1AdvancedSettings": { "description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettings", @@ -8055,6 +8410,10 @@ "description": "AgentUtterance represents one message sent by the agent.", "id": "GoogleCloudDialogflowCxV3beta1AgentUtterance", "properties": { + "requireGeneration": { + "description": "Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer.", + "type": "boolean" + }, "text": { "description": "Required. Message content in text.", "type": "string" @@ -9526,6 +9885,10 @@ "event": { "description": "Required. Name of the event.", "type": "string" + }, + "text": { + "description": "Optional. Unstructured text payload of the event.", + "type": "string" } }, "type": "object" @@ -9649,6 +10012,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExceptionDetail": { + "description": "Exception thrown during the execution of an action.", + "id": "GoogleCloudDialogflowCxV3beta1ExceptionDetail", + "properties": { + "errorMessage": { + "description": "Optional. The error message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1Experiment": { "description": "Represents an experiment in an environment.", "id": "GoogleCloudDialogflowCxV3beta1Experiment", @@ -10102,6 +10476,31 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest": { + "description": "The request message for Playbooks.ExportPlaybook.", + "id": "GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest", + "properties": { + "dataFormat": { + "description": "Optional. The data format of the exported agent. If not specified, `BLOB` is assumed.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "BLOB", + "JSON" + ], + "enumDescriptions": [ + "Unspecified format.", + "Flow content will be exported as raw bytes.", + "Flow content will be exported in JSON format." + ], + "type": "string" + }, + "playbookUri": { + "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the playbook to. The format of this URI must be `gs:///`. If left unspecified, the serialized playbook is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -10161,13 +10560,11 @@ "description": "Optional. The data format of the exported tools. If not specified, `BLOB` is assumed.", "enum": [ "DATA_FORMAT_UNSPECIFIED", - "BLOB", - "JSON" + "BLOB" ], "enumDescriptions": [ "Unspecified format. Treated as `BLOB`.", - "Tools will be exported as raw bytes.", - "Tools will be exported in JSON format." + "Tools will be exported as raw bytes." ], "type": "string" }, @@ -10295,7 +10692,7 @@ "type": "object" }, "GoogleCloudDialogflowCxV3beta1FlowInvocation": { - "description": "Stores metadata of the invocation of a CX flow.", + "description": "Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow.", "id": "GoogleCloudDialogflowCxV3beta1FlowInvocation", "properties": { "displayName": { @@ -10304,7 +10701,7 @@ "type": "string" }, "flow": { - "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.", + "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents/`.", "type": "string" }, "flowState": { @@ -10376,6 +10773,15 @@ "flow": { "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents/`.", "type": "string" + }, + "inputActionParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "deprecated": true, + "description": "A list of input parameters for the action.", + "type": "object" } }, "type": "object" @@ -11104,6 +11510,26 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest": { + "description": "The request message for Playbooks.ImportPlaybook.", + "id": "GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest", + "properties": { + "importStrategy": { + "$ref": "GoogleCloudDialogflowCxV3beta1PlaybookImportStrategy", + "description": "Optional. Specifies the import strategy used when resolving resource conflicts." + }, + "playbookContent": { + "description": "Uncompressed raw byte content for playbook.", + "format": "byte", + "type": "string" + }, + "playbookUri": { + "description": "[Dialogflow access control] (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -11921,6 +12347,95 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1LlmCall": { + "description": "Stores metadata of the call of an LLM.", + "id": "GoogleCloudDialogflowCxV3beta1LlmCall", + "properties": { + "model": { + "description": "The model of the LLM call.", + "type": "string" + }, + "retrievedExamples": { + "description": "A list of relevant examples used for the LLM prompt.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1LlmCallRetrievedExample" + }, + "type": "array" + }, + "temperature": { + "description": "The temperature of the LLM call.", + "format": "float", + "type": "number" + }, + "tokenCount": { + "$ref": "GoogleCloudDialogflowCxV3beta1LlmCallTokenCount", + "description": "The token counts of the LLM call." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1LlmCallRetrievedExample": { + "description": "Relevant example used for the LLM prompt.", + "id": "GoogleCloudDialogflowCxV3beta1LlmCallRetrievedExample", + "properties": { + "exampleDisplayName": { + "description": "The display name of the example.", + "type": "string" + }, + "exampleId": { + "description": "The id of the example.", + "type": "string" + }, + "matchedRetrievalLabel": { + "description": "Optional. The matched retrieval label of this LLM call.", + "type": "string" + }, + "retrievalStrategy": { + "description": "Retrieval strategy of the example.", + "enum": [ + "RETRIEVAL_STRATEGY_UNSPECIFIED", + "DEFAULT", + "STATIC", + "NEVER" + ], + "enumDescriptions": [ + "Not specified. `DEFAULT` will be used.", + "Default retrieval strategy.", + "Static example will always be inserted to the prompt.", + "Example will never be inserted into the prompt." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1LlmCallTokenCount": { + "description": "Stores token counts of the LLM call.", + "id": "GoogleCloudDialogflowCxV3beta1LlmCallTokenCount", + "properties": { + "conversationContextTokenCount": { + "description": "The number of tokens used for the conversation history in the prompt.", + "format": "int64", + "type": "string" + }, + "exampleTokenCount": { + "description": "The number of tokens used for the retrieved examples in the prompt.", + "format": "int64", + "type": "string" + }, + "totalInputTokenCount": { + "description": "The total number of tokens used for the input to the LLM call.", + "format": "int64", + "type": "string" + }, + "totalOutputTokenCount": { + "description": "The total number of tokens used for the output of the LLM call.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1LlmModelSettings": { "description": "Settings for LLM models.", "id": "GoogleCloudDialogflowCxV3beta1LlmModelSettings", @@ -12076,6 +12591,25 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1NamedMetric": { + "description": "A named metric is a metric with name, value and unit.", + "id": "GoogleCloudDialogflowCxV3beta1NamedMetric", + "properties": { + "name": { + "description": "The name of the metric.", + "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.", + "type": "string" + }, + "value": { + "description": "The value of the metric.", + "type": "any" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1NluSettings": { "description": "Settings related to NLU.", "id": "GoogleCloudDialogflowCxV3beta1NluSettings", @@ -12442,6 +12976,73 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1PlaybookImportStrategy": { + "description": "The playbook import strategy used for resource conflict resolution associated with an ImportPlaybookRequest.", + "id": "GoogleCloudDialogflowCxV3beta1PlaybookImportStrategy", + "properties": { + "mainPlaybookImportStrategy": { + "description": "Optional. Specifies the import strategy used when resolving conflicts with the main playbook. If not specified, 'CREATE_NEW' is assumed.", + "enum": [ + "IMPORT_STRATEGY_UNSPECIFIED", + "IMPORT_STRATEGY_CREATE_NEW", + "IMPORT_STRATEGY_REPLACE", + "IMPORT_STRATEGY_KEEP", + "IMPORT_STRATEGY_MERGE", + "IMPORT_STRATEGY_THROW_ERROR" + ], + "enumDescriptions": [ + "Unspecified. Treated as 'CREATE_NEW'.", + "Create a new resource with a numeric suffix appended to the end of the existing display name.", + "Replace existing resource with incoming resource in the content to be imported.", + "Keep existing resource and discard incoming resource in the content to be imported.", + "Combine existing and incoming resources when a conflict is encountered.", + "Throw error if a conflict is encountered." + ], + "type": "string" + }, + "nestedResourceImportStrategy": { + "description": "Optional. Specifies the import strategy used when resolving referenced playbook/flow conflicts. If not specified, 'CREATE_NEW' is assumed.", + "enum": [ + "IMPORT_STRATEGY_UNSPECIFIED", + "IMPORT_STRATEGY_CREATE_NEW", + "IMPORT_STRATEGY_REPLACE", + "IMPORT_STRATEGY_KEEP", + "IMPORT_STRATEGY_MERGE", + "IMPORT_STRATEGY_THROW_ERROR" + ], + "enumDescriptions": [ + "Unspecified. Treated as 'CREATE_NEW'.", + "Create a new resource with a numeric suffix appended to the end of the existing display name.", + "Replace existing resource with incoming resource in the content to be imported.", + "Keep existing resource and discard incoming resource in the content to be imported.", + "Combine existing and incoming resources when a conflict is encountered.", + "Throw error if a conflict is encountered." + ], + "type": "string" + }, + "toolImportStrategy": { + "description": "Optional. Specifies the import strategy used when resolving tool conflicts. If not specified, 'CREATE_NEW' is assumed. This will be applied after the main playbook and nested resource import strategies, meaning if the playbook that references the tool is skipped, the tool will also be skipped.", + "enum": [ + "IMPORT_STRATEGY_UNSPECIFIED", + "IMPORT_STRATEGY_CREATE_NEW", + "IMPORT_STRATEGY_REPLACE", + "IMPORT_STRATEGY_KEEP", + "IMPORT_STRATEGY_MERGE", + "IMPORT_STRATEGY_THROW_ERROR" + ], + "enumDescriptions": [ + "Unspecified. Treated as 'CREATE_NEW'.", + "Create a new resource with a numeric suffix appended to the end of the existing display name.", + "Replace existing resource with incoming resource in the content to be imported.", + "Keep existing resource and discard incoming resource in the content to be imported.", + "Combine existing and incoming resources when a conflict is encountered.", + "Throw error if a conflict is encountered." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1PlaybookInput": { "description": "Input of the playbook.", "id": "GoogleCloudDialogflowCxV3beta1PlaybookInput", @@ -12480,7 +13081,7 @@ "type": "object" }, "GoogleCloudDialogflowCxV3beta1PlaybookInvocation": { - "description": "Stores metadata of the invocation of a child playbook.", + "description": "Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook.", "id": "GoogleCloudDialogflowCxV3beta1PlaybookInvocation", "properties": { "displayName": { @@ -12538,6 +13139,25 @@ "executionSummary": { "description": "Optional. Summary string of the execution result of the child playbook.", "type": "string" + }, + "state": { + "deprecated": true, + "description": "End state of the playbook.", + "enum": [ + "STATE_UNSPECIFIED", + "OK", + "CANCELLED", + "FAILED", + "ESCALATED" + ], + "enumDescriptions": [ + "Unspecified state.", + "Playbook succeeded.", + "Playbook cancelled.", + "Playbook failed.", + "Playbook failed due to escalation." + ], + "type": "string" } }, "type": "object" @@ -12569,6 +13189,15 @@ "readOnly": true, "type": "string" }, + "inputActionParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "deprecated": true, + "description": "A list of input parameters for the action.", + "type": "object" + }, "playbook": { "description": "Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.", "type": "string" @@ -13151,6 +13780,23 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest": { + "description": "The request message for Playbooks.RestorePlaybookVersion.", + "id": "GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse": { + "description": "The response message for Playbooks.RestorePlaybookVersion.", + "id": "GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse", + "properties": { + "playbook": { + "$ref": "GoogleCloudDialogflowCxV3beta1Playbook", + "description": "The updated playbook." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest": { "description": "The request message for Tools.RestoreToolVersion.", "id": "GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest", @@ -13559,6 +14205,41 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1Span": { + "description": "A span represents a sub execution step of an action.", + "id": "GoogleCloudDialogflowCxV3beta1Span", + "properties": { + "completeTime": { + "description": "Timestamp of the completion of the span.", + "format": "google-datetime", + "type": "string" + }, + "metrics": { + "description": "The unordered collection of metrics in this span.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1NamedMetric" + }, + "type": "array" + }, + "name": { + "description": "The name of the span.", + "type": "string" + }, + "startTime": { + "description": "Timestamp of the start of the span.", + "format": "google-datetime", + "type": "string" + }, + "tags": { + "description": "The metadata tags of the span such as span type.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1SpeechToTextSettings": { "description": "Settings related to speech recognition.", "id": "GoogleCloudDialogflowCxV3beta1SpeechToTextSettings", @@ -13576,6 +14257,17 @@ "properties": {}, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1Status": { + "description": "The status of the action.", + "id": "GoogleCloudDialogflowCxV3beta1Status", + "properties": { + "exception": { + "$ref": "GoogleCloudDialogflowCxV3beta1ExceptionDetail", + "description": "Optional. The exception thrown during the execution of the action." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1StopExperimentRequest": { "description": "The request message for Experiments.StopExperiment.", "id": "GoogleCloudDialogflowCxV3beta1StopExperimentRequest", @@ -13938,6 +14630,10 @@ "Represents the key in query string." ], "type": "string" + }, + "secretVersionForApiKey": { + "description": "Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" } }, "type": "object" @@ -13946,6 +14642,10 @@ "description": "Config for authentication using bearer token.", "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig", "properties": { + "secretVersionForToken": { + "description": "Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "token": { "description": "Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.", "type": "string" @@ -13984,6 +14684,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint in the OAuth provider to exchange for an access token.", "type": "string" @@ -14330,6 +15034,10 @@ "description": "Optional. Name of the action to be called during the tool use.", "type": "string" }, + "dataStoreToolTrace": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace", + "description": "Optional. Data store tool trace." + }, "displayName": { "description": "Output only. The display name of the tool.", "readOnly": true, @@ -14354,6 +15062,36 @@ "tool": { "description": "Required. The tool that should be used. Format: `projects//locations//agents//tools/`.", "type": "string" + }, + "webhookToolTrace": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace", + "description": "Optional. Webhook tool trace." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace": { + "description": "The tracing information for the data store tool.", + "id": "GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace", + "properties": { + "dataStoreConnectionSignals": { + "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals", + "description": "Optional. Data store connection feature output signals." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace": { + "description": "The tracing information for the webhook tool.", + "id": "GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace", + "properties": { + "webhookTag": { + "description": "Optional. The tag of the webhook.", + "type": "string" + }, + "webhookUri": { + "description": "Optional. The url of the webhook.", + "type": "string" } }, "type": "object" @@ -14675,6 +15413,19 @@ "description": "UserUtterance represents one message sent by the customer.", "id": "GoogleCloudDialogflowCxV3beta1UserUtterance", "properties": { + "audio": { + "description": "Optional. Audio input.", + "format": "byte", + "type": "string" + }, + "audioTokens": { + "description": "Optional. Tokens of the audio input.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, "text": { "description": "Required. Message content in text.", "type": "string" @@ -15003,6 +15754,17 @@ "description": "The HTTP request headers to send together with webhook requests.", "type": "object" }, + "secretVersionForUsernamePassword": { + "description": "Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "secretVersionsForRequestHeaders": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue" + }, + "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", + "type": "object" + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -15064,6 +15826,10 @@ }, "type": "array" }, + "secretVersionForClientSecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" @@ -15071,6 +15837,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue": { + "description": "Represents the value of an HTTP header stored in a SecretManager secret version.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue", + "properties": { + "secretVersion": { + "description": "Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", @@ -15968,6 +16745,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -17706,6 +18505,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "description": "Metadata for a ConversationModels.UndeployConversationModel operation.", "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", @@ -18259,6 +19132,28 @@ "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", "description": "Optional. Suggested summary." + }, + "toolCallInfo": { + "description": "Optional. List of request and response for tool calls executed.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo": { + "description": "Request and response for a tool call.", + "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo", + "properties": { + "toolCall": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCall", + "description": "Required. Request for a tool call." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResult", + "description": "Required. Response for a tool call." } }, "type": "object" @@ -20253,15 +21148,15 @@ "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", - "DTMF_DIGITS", "END_OF_SINGLE_UTTERANCE", + "DTMF_DIGITS", "PARTIAL_DTMF_DIGITS" ], "enumDescriptions": [ "Not specified. Should never be used.", "Message contains a (possibly partial) transcript.", - "Message contains DTMF digits.", "This event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if `single_utterance` was set to `true`, and is not used otherwise.", + "Message contains DTMF digits.", "Message contains DTMF digits. Before a message with DTMF_DIGITS is sent, a message with PARTIAL_DTMF_DIGITS may be sent with DTMF digits collected up to the time of sending, which represents an intermediate result." ], "type": "string" @@ -20523,6 +21418,80 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowV2beta1ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResult": { + "description": "The result of calling a tool's action.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "content": { + "description": "Only populated if the response content is utf-8 encoded.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the tool call result.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "description": "The tool call's error." + }, + "rawContent": { + "description": "Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).", + "format": "byte", + "type": "string" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowV2beta1ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1WebhookRequest": { "description": "The request message for a webhook call.", "id": "GoogleCloudDialogflowV2beta1WebhookRequest", diff --git a/discovery/digitalassetlinks-v1.json b/discovery/digitalassetlinks-v1.json index 9a7cd5f8453..3d80b7a88cb 100644 --- a/discovery/digitalassetlinks-v1.json +++ b/discovery/digitalassetlinks-v1.json @@ -124,6 +124,11 @@ "location": "query", "type": "string" }, + "returnRelationExtensions": { + "description": "Whether to return relation_extensions payloads specified in the source Digital Asset Links statements linking the requested source and target assets by the requested relation type. If this is set to `false` (default), relation_extensions specified will not be returned, even if they are specified in the DAL statement file. If set to `true`, the API will propagate any and all relation_extensions, across statements, linking the source and target assets by the requested relation type, if specified in the DAL statement file.", + "location": "query", + "type": "boolean" + }, "source.androidApp.certificate.sha256Fingerprint": { "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons).", "location": "query", @@ -176,6 +181,11 @@ "location": "query", "type": "string" }, + "returnRelationExtensions": { + "description": "Whether to return any relation_extensions payloads specified in the source digital asset links statements. If this is set to `false` (default), relation_extensions specified will not be returned, even if they are specified in the DAL statement file. If set to `true`, the API will propagate relation_extensions associated with each statement's relation type, if specified in the DAL statement file.", + "location": "query", + "type": "boolean" + }, "source.androidApp.certificate.sha256Fingerprint": { "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons).", "location": "query", @@ -200,7 +210,7 @@ } } }, - "revision": "20250211", + "revision": "20250405", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": { @@ -249,6 +259,10 @@ "$ref": "Asset", "description": "If specified, will be used in any given template statement that doesn’t specify a target." }, + "returnRelationExtensions": { + "description": "Same configuration as in CheckRequest; all statement checks will use the same configuration.", + "type": "boolean" + }, "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": { @@ -363,6 +377,17 @@ "description": "From serving time, how much longer the response should be considered valid barring further updates. REQUIRED", "format": "google-duration", "type": "string" + }, + "relationExtensions": { + "description": "Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset. When requested, the API will return relation_extensions specified in any and all statements linking the requested source and target assets by the relation specified in the request.", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "type": "array" } }, "type": "object" @@ -431,6 +456,14 @@ "description": "The relation identifies the use of the statement as intended by the source asset's owner (that is, the person or entity who issued the statement). Every complete statement has a 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. Example: `delegate_permission/common.handle_all_urls` REQUIRED", "type": "string" }, + "relationExtensions": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset. These relation extensions should be specified in the `relation_extensions` object, keyed by the relation type they're associated with. { relation: [\"delegate_permission/common.handle_all_urls\"], target: {...}, relation_extensions: { \"delegate_permission/common.handle_all_urls\": { ...handle_all_urls specific payload specified here... } } } When requested, and specified in the statement file, the API will return relation_extensions associated with the statement's relation type. i.e. the API will only return relation_extensions specified for \"delegate_permission/common.handle_all_urls\" if this statement object's relation type is \"delegate_permission/common.handle_all_urls\".", + "type": "object" + }, "source": { "$ref": "Asset", "description": "Every statement has a source asset. REQUIRED" diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 0711b05ab25..d83a98f26e9 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -160,7 +160,179 @@ }, "resources": { "locations": { + "methods": { + "getCmekConfig": { + "description": "Gets the CmekConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.getCmekConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateCmekConfig": { + "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.updateCmekConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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, + "type": "string" + }, + "setDefault": { + "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { + "cmekConfigs": { + "methods": { + "delete": { + "description": "De-provisions a CmekConfig.", + "flatPath": "v1/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": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the CmekConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.cmekConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the CmekConfigs with the project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.cmekConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cmekConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.cmekConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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, + "type": "string" + }, + "setDefault": { + "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "collections": { "resources": { "dataConnector": { @@ -3335,6 +3507,34 @@ }, "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}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleLongrunningCancelOperationRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}", @@ -6773,7 +6973,7 @@ } } }, - "revision": "20250314", + "revision": "20250425", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7252,7 +7452,8 @@ "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", - "LOW_GROUNDED_ANSWER" + "LOW_GROUNDED_ANSWER", + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -7264,7 +7465,8 @@ "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." + "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." ], "type": "string" }, @@ -7397,6 +7599,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { + "description": "The specification for answer generation.", + "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "properties": { + "userDefinedClassifierSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", + "description": "Optional. The specification for user specified classifier spec." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": { + "description": "The specification for user defined classifier.", + "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", + "properties": { + "enableUserDefinedClassifier": { + "description": "Optional. Whether or not to enable and include user defined classifier.", + "type": "boolean" + }, + "modelId": { + "description": "Optional. The model id to be used for the user defined classifier.", + "type": "string" + }, + "preamble": { + "description": "Optional. The preamble to be used for the user defined classifier.", + "type": "string" + }, + "seed": { + "description": "Optional. The seed value to be used for the user defined classifier.", + "format": "int32", + "type": "integer" + }, + "taskMarker": { + "description": "Optional. The task marker to be used for the user defined classifier.", + "type": "string" + }, + "temperature": { + "description": "Optional. The temperature value to be used for the user defined classifier.", + "format": "double", + "type": "number" + }, + "topK": { + "description": "Optional. The top-k value to be used for the user defined classifier.", + "format": "int64", + "type": "string" + }, + "topP": { + "description": "Optional. The top-p value to be used for the user defined classifier.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AnswerGroundingSupport": { "description": "Grounding support for a claim in `answer_text`.", "id": "GoogleCloudDiscoveryengineV1AnswerGroundingSupport", @@ -7657,14 +7913,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" }, @@ -8047,14 +8305,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" } @@ -8767,6 +9027,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.", "type": "boolean" }, + "score": { + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true.", + "format": "double", + "type": "number" + }, "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", @@ -8783,6 +9048,10 @@ "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" + }, + "enableClaimLevelScore": { + "description": "The control flag that enables claim-level grounding score in the response.", + "type": "boolean" } }, "type": "object" @@ -8791,6 +9060,14 @@ "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", "id": "GoogleCloudDiscoveryengineV1Chunk", "properties": { + "annotationContents": { + "description": "Output only. Annotation contents if the current chunk contains annotations.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "chunkMetadata": { "$ref": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata", "description": "Output only. Metadata of the current chunk.", @@ -8800,6 +9077,14 @@ "description": "Content is a string from a document (parsed content).", "type": "string" }, + "dataUrls": { + "description": "Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "derivedStructData": { "additionalProperties": { "description": "Properties of the object.", @@ -9110,7 +9395,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -9729,6 +10014,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "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": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", "description": "Optional. Configuration for advanced site search." @@ -10052,9 +10341,13 @@ "description": "Document captures all raw metadata information of items to be recommended or searched.", "id": "GoogleCloudDiscoveryengineV1Document", "properties": { + "aclInfo": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentAclInfo", + "description": "Access control information for the document." + }, "content": { "$ref": "GoogleCloudDiscoveryengineV1DocumentContent", - "description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store." + "description": "The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store." }, "derivedStructData": { "additionalProperties": { @@ -10107,12 +10400,44 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentAclInfo": { + "description": "ACL Information of the Document.", + "id": "GoogleCloudDiscoveryengineV1DocumentAclInfo", + "properties": { + "readers": { + "description": "Readers of the document.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction": { + "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": "GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction", + "properties": { + "idpWide": { + "description": "All users within the Identity Provider.", + "type": "boolean" + }, + "principals": { + "description": "List of principals.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1Principal" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentContent": { "description": "Unstructured data linked to this document.", "id": "GoogleCloudDiscoveryengineV1DocumentContent", "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.", + "description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, "rawBytes": { @@ -10272,7 +10597,37 @@ "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -10392,6 +10747,10 @@ ], "type": "string" }, + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, "name": { "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/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" @@ -10462,30 +10821,121 @@ "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", "type": "string" }, - "timeZone": { - "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "properties": { + "companyName": { + "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", + "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "type": "string" + }, + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + }, + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" + }, + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "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.", + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", "type": "string" } }, @@ -10535,6 +10985,10 @@ "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" }, + "domain": { + "description": "The domain of the source.", + "type": "string" + }, "index": { "description": "The index of this chunk. Currently, only used for the streaming mode.", "format": "int32", @@ -10550,6 +11004,14 @@ }, "description": "More fine-grained information for the source reference.", "type": "object" + }, + "title": { + "description": "The title of the source.", + "type": "string" + }, + "uri": { + "description": "The URI of the source.", + "type": "string" } }, "type": "object" @@ -11226,6 +11688,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse": { + "description": "Response message for CmekConfigService.ListCmekConfigs method.", + "id": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse", + "properties": { + "cmekConfigs": { + "description": "All the customer's CmekConfigs.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ListControlsResponse": { "description": "Response for ListControls method.", "id": "GoogleCloudDiscoveryengineV1ListControlsResponse", @@ -11497,6 +11973,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Principal": { + "description": "Principal identifier of a user or a group.", + "id": "GoogleCloudDiscoveryengineV1Principal", + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Project": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", @@ -12168,6 +12659,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -12208,7 +12703,7 @@ "description": "A specification for configuring the behavior of content search." }, "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.", + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, @@ -12340,7 +12835,7 @@ "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec", "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.", + "description": "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": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec" }, @@ -13179,6 +13674,10 @@ "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": { + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "description": "Optional. The specification for answer generation." + }, "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": { @@ -13568,14 +14067,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -13958,6 +14461,10 @@ "description": "Information of an end user.", "id": "GoogleCloudDiscoveryengineV1UserInfo", "properties": { + "timeZone": { + "description": "Optional. IANA time zone, e.g. Europe/Budapest.", + "type": "string" + }, "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" @@ -14045,6 +14552,10 @@ "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", "readOnly": true, "type": "boolean" + }, + "serviceName": { + "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", + "type": "string" } }, "type": "object" @@ -14124,7 +14635,8 @@ "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", - "LOW_GROUNDED_ANSWER" + "LOW_GROUNDED_ANSWER", + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -14136,7 +14648,8 @@ "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." + "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." ], "type": "string" }, @@ -14383,14 +14896,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" } @@ -14897,7 +15412,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -15506,6 +16021,10 @@ "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": { + "aclEnabled": { + "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", + "type": "boolean" + }, "actionConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", "description": "Optional. Action configurations to make the connector support actions." @@ -15543,6 +16062,27 @@ "readOnly": true, "type": "array" }, + "connectorModes": { + "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "FEDERATED", + "EUA" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for actions.", + "Connector utilized for federated search.", + "Connector utilized for End User Authentication." + ], + "type": "string" + }, + "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": [ @@ -15555,7 +16095,8 @@ "GOOGLE_CALENDAR", "GOOGLE_DRIVE", "NATIVE_CLOUD_IDENTITY", - "THIRD_PARTY_FEDERATED" + "THIRD_PARTY_FEDERATED", + "THIRD_PARTY_EUA" ], "enumDescriptions": [ "Default value.", @@ -15567,7 +16108,8 @@ "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." + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", + "Connector utilized for End User Authentication features." ], "readOnly": true, "type": "string" @@ -15589,6 +16131,10 @@ }, "type": "array" }, + "endUserConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", + "description": "Optional. Any params and credentials used specifically for EUA connectors." + }, "entities": { "description": "List of entities from the connected data source to ingest.", "items": { @@ -15675,6 +16221,10 @@ "readOnly": true, "type": "string" }, + "realtimeSyncConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", + "description": "Optional. The configuration for realtime sync." + }, "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", @@ -15738,6 +16288,44 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { + "description": "Any params and credentials used specifically for EUA connectors.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for EUA.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to EUA connectors.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { + "description": "The configuration for realtime sync to store additional params for realtime sync.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", + "properties": { + "realtimeSyncSecret": { + "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", + "type": "string" + }, + "webhookUri": { + "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": { "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity", @@ -16285,7 +16873,37 @@ "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -16500,6 +17118,10 @@ "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, "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" @@ -16529,6 +17151,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "description": "Custom threshold for `cvr` optimization_objective.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", @@ -16545,6 +17194,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { "description": "Additional information of a recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", @@ -18081,6 +18741,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -18125,7 +18789,7 @@ "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.", + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, @@ -18205,13 +18869,13 @@ "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", + "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_backend 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_backend 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", + "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX" ], @@ -18295,7 +18959,7 @@ "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.", + "description": "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": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, @@ -19123,14 +19787,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -19356,6 +20024,10 @@ "description": "Information of an end user.", "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { + "timeZone": { + "description": "Optional. IANA time zone, e.g. Europe/Budapest.", + "type": "string" + }, "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" @@ -19549,7 +20221,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -19930,6 +20602,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "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": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", "description": "Optional. Configuration for advanced site search." @@ -20338,7 +21014,37 @@ "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -20437,6 +21143,10 @@ ], "type": "string" }, + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, "name": { "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/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" @@ -20536,6 +21246,97 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", + "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "type": "string" + }, + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + }, + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "properties": { + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "type": "string" + }, + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { "description": "Configurations for a Search Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", @@ -21382,6 +22183,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -21422,7 +22227,7 @@ "description": "A specification for configuring the behavior of content search." }, "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.", + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, @@ -21502,13 +22307,13 @@ "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", + "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_backend 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_backend 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", + "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX" ], @@ -21592,7 +22397,7 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "description": "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": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" }, @@ -22317,14 +23122,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -22500,6 +23309,10 @@ "description": "Information of an end user.", "id": "GoogleCloudDiscoveryengineV1betaUserInfo", "properties": { + "timeZone": { + "description": "Optional. IANA time zone, e.g. Europe/Budapest.", + "type": "string" + }, "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" diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index d8ea764cde7..2b47f5d894b 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -795,7 +795,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - destination_configs - blocking_reasons Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.", + "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -816,6 +816,31 @@ "resources": { "dataConnector": { "methods": { + "getConnectorSecret": { + "description": "Get the secret for the associated connector.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:getConnectorSecret", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataConnector.getConnectorSecret", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the associated data connector.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:getConnectorSecret", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "startConnectorRun": { "description": "Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:startConnectorRun", @@ -1432,6 +1457,11 @@ "name" ], "parameters": { + "imageId": { + "description": "Optional. Specifies config for IMAGE_BYTES.", + "location": "query", + "type": "string" + }, "name": { "description": "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.", "location": "path", @@ -5622,6 +5652,11 @@ "name" ], "parameters": { + "imageId": { + "description": "Optional. Specifies config for IMAGE_BYTES.", + "location": "query", + "type": "string" + }, "name": { "description": "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.", "location": "path", @@ -9016,7 +9051,7 @@ } } }, - "revision": "20250314", + "revision": "20250425", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -9093,6 +9128,11 @@ "format": "byte", "type": "string" }, + "destinationBlobMintIndex": { + "description": "For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.", + "format": "int32", + "type": "integer" + }, "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", @@ -9106,6 +9146,11 @@ "$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." }, + "originalObjectBlobMintIndex": { + "description": "For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.", + "format": "int32", + "type": "integer" + }, "requestClass": { "description": "Request class to use for all Blobstore operations for this request.", "enum": [ @@ -10029,6 +10074,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { + "description": "The specification for answer generation.", + "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "properties": { + "userDefinedClassifierSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", + "description": "Optional. The specification for user specified classifier spec." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": { + "description": "The specification for user defined classifier.", + "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", + "properties": { + "enableUserDefinedClassifier": { + "description": "Optional. Whether or not to enable and include user defined classifier.", + "type": "boolean" + }, + "modelId": { + "description": "Optional. The model id to be used for the user defined classifier.", + "type": "string" + }, + "preamble": { + "description": "Optional. The preamble to be used for the user defined classifier.", + "type": "string" + }, + "seed": { + "description": "Optional. The seed value to be used for the user defined classifier.", + "format": "int32", + "type": "integer" + }, + "taskMarker": { + "description": "Optional. The task marker to be used for the user defined classifier.", + "type": "string" + }, + "temperature": { + "description": "Optional. The temperature value to be used for the user defined classifier.", + "format": "double", + "type": "number" + }, + "topK": { + "description": "Optional. The top-k value to be used for the user defined classifier.", + "format": "int64", + "type": "string" + }, + "topP": { + "description": "Optional. The top-p value to be used for the user defined classifier.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", @@ -10151,7 +10250,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -10515,6 +10614,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "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": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", "description": "Optional. Configuration for advanced site search." @@ -10909,7 +11012,37 @@ "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -11008,6 +11141,10 @@ ], "type": "string" }, + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, "name": { "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/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" @@ -11107,6 +11244,97 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", + "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "type": "string" + }, + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + }, + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "properties": { + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "type": "string" + }, + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { "description": "Configurations for a Search Engine.", "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", @@ -11628,6 +11856,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -11828,6 +12060,10 @@ "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": { + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "description": "Optional. The specification for answer generation." + }, "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": { @@ -12080,14 +12316,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -12335,6 +12575,10 @@ "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", "readOnly": true, "type": "boolean" + }, + "serviceName": { + "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", + "type": "string" } }, "type": "object" @@ -12347,6 +12591,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec", "description": "Optional. Specification to boost suggestions matching the condition." }, + "experimentIds": { + "description": "Optional. Experiment ids for this request.", + "items": { + "type": "string" + }, + "type": "array" + }, "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" @@ -12405,7 +12656,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec", "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.", + "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifications, 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" }, @@ -12750,7 +13001,8 @@ "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", - "LOW_GROUNDED_ANSWER" + "LOW_GROUNDED_ANSWER", + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -12762,7 +13014,8 @@ "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." + "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." ], "type": "string" }, @@ -12947,6 +13200,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec": { + "description": "The specification for answer generation.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec", + "properties": { + "userDefinedClassifierSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec", + "description": "Optional. The specification for user specified classifier spec." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec": { + "description": "The specification for user defined classifier.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec", + "properties": { + "enableUserDefinedClassifier": { + "description": "Optional. Whether or not to enable and include user defined classifier.", + "type": "boolean" + }, + "modelId": { + "description": "Optional. The model id to be used for the user defined classifier.", + "type": "string" + }, + "preamble": { + "description": "Optional. The preamble to be used for the user defined classifier.", + "type": "string" + }, + "seed": { + "description": "Optional. The seed value to be used for the user defined classifier.", + "format": "int32", + "type": "integer" + }, + "taskMarker": { + "description": "Optional. The task marker to be used for the user defined classifier.", + "type": "string" + }, + "temperature": { + "description": "Optional. The temperature value to be used for the user defined classifier.", + "format": "double", + "type": "number" + }, + "topK": { + "description": "Optional. The top-k value to be used for the user defined classifier.", + "format": "int64", + "type": "string" + }, + "topP": { + "description": "Optional. The top-p value to be used for the user defined classifier.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": { "description": "Grounding support for a claim in `answer_text`.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport", @@ -13234,14 +13541,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" }, @@ -13632,14 +13941,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" } @@ -14394,6 +14705,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.", "type": "boolean" }, + "score": { + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true.", + "format": "double", + "type": "number" + }, "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", @@ -14410,6 +14726,10 @@ "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" + }, + "enableClaimLevelScore": { + "description": "The control flag that enables claim-level grounding score in the response.", + "type": "boolean" } }, "type": "object" @@ -14495,6 +14815,14 @@ "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", "id": "GoogleCloudDiscoveryengineV1alphaChunk", "properties": { + "annotationContents": { + "description": "Output only. Annotation contents if the current chunk contains annotations.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "chunkMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", "description": "Output only. Metadata of the current chunk.", @@ -14504,6 +14832,14 @@ "description": "Content is a string from a document (parsed content).", "type": "string" }, + "dataUrls": { + "description": "Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "derivedStructData": { "additionalProperties": { "description": "Properties of the object.", @@ -14840,7 +15176,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -15711,6 +16047,10 @@ "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": { + "aclEnabled": { + "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", + "type": "boolean" + }, "actionConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", "description": "Optional. Action configurations to make the connector support actions." @@ -15748,6 +16088,27 @@ "readOnly": true, "type": "array" }, + "connectorModes": { + "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "FEDERATED", + "EUA" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for actions.", + "Connector utilized for federated search.", + "Connector utilized for End User Authentication." + ], + "type": "string" + }, + "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": [ @@ -15760,7 +16121,8 @@ "GOOGLE_CALENDAR", "GOOGLE_DRIVE", "NATIVE_CLOUD_IDENTITY", - "THIRD_PARTY_FEDERATED" + "THIRD_PARTY_FEDERATED", + "THIRD_PARTY_EUA" ], "enumDescriptions": [ "Default value.", @@ -15772,7 +16134,8 @@ "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." + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", + "Connector utilized for End User Authentication features." ], "readOnly": true, "type": "string" @@ -15794,6 +16157,10 @@ }, "type": "array" }, + "endUserConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", + "description": "Optional. Any params and credentials used specifically for EUA connectors." + }, "entities": { "description": "List of entities from the connected data source to ingest.", "items": { @@ -15880,6 +16247,10 @@ "readOnly": true, "type": "string" }, + "realtimeSyncConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", + "description": "Optional. The configuration for realtime sync." + }, "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", @@ -15943,6 +16314,44 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { + "description": "Any params and credentials used specifically for EUA connectors.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for EUA.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to EUA connectors.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { + "description": "The configuration for realtime sync to store additional params for realtime sync.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", + "properties": { + "realtimeSyncSecret": { + "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", + "type": "string" + }, + "webhookUri": { + "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": { "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity", @@ -16425,7 +16834,7 @@ }, "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." + "description": "The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store." }, "derivedStructData": { "additionalProperties": { @@ -16515,7 +16924,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", "properties": { "mimeType": { - "description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.", + "description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, "rawBytes": { @@ -16675,7 +17084,37 @@ "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -16922,6 +17361,10 @@ "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, "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" @@ -16951,6 +17394,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "description": "Custom threshold for `cvr` optimization_objective.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", @@ -16967,6 +17437,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { "description": "Additional information of a recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", @@ -17249,6 +17730,10 @@ "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" }, + "domain": { + "description": "The domain of the source.", + "type": "string" + }, "index": { "description": "The index of this chunk. Currently, only used for the streaming mode.", "format": "int32", @@ -17264,6 +17749,14 @@ }, "description": "More fine-grained information for the source reference.", "type": "object" + }, + "title": { + "description": "The title of the source.", + "type": "string" + }, + "uri": { + "description": "The URI of the source.", + "type": "string" } }, "type": "object" @@ -17540,6 +18033,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse": { + "description": "Response message for DataConnectorService.GetConnectorSecret.", + "id": "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse", + "properties": { + "app": { + "description": "The app name of the associated Connector.", + "type": "string" + }, + "authorizationUri": { + "description": "The authorization uri for the data connector.", + "type": "string" + }, + "clientId": { + "description": "The client id of the associated Connector.", + "type": "string" + }, + "instance": { + "description": "The instance name of the associated Connector.", + "type": "string" + }, + "redirectUri": { + "description": "The redirect url of the associated Connector.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id of the associated Connector.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaGetSessionRequest": { "description": "Request for GetSession method.", "id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest", @@ -20203,6 +20727,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -20247,7 +20775,7 @@ "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.", + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, @@ -20327,13 +20855,13 @@ "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", + "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_backend 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_backend 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", + "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX" ], @@ -20417,7 +20945,7 @@ "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.", + "description": "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": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, @@ -21741,6 +22269,10 @@ "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": { + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec", + "description": "Optional. The specification for answer generation." + }, "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": { @@ -22345,14 +22877,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -22791,6 +23327,10 @@ "description": "Information of an end user.", "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { + "timeZone": { + "description": "Optional. IANA time zone, e.g. Europe/Budapest.", + "type": "string" + }, "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" @@ -23080,8 +23620,25 @@ "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings", "properties": { "googleSearchGroundingEnabled": { - "description": "Whether or not the Google search grounding toggle is shown.", + "deprecated": true, + "description": "Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.", "type": "boolean" + }, + "webGroundingType": { + "description": "Optional. The type of web grounding to use.", + "enum": [ + "WEB_GROUNDING_TYPE_UNSPECIFIED", + "WEB_GROUNDING_TYPE_DISABLED", + "WEB_GROUNDING_TYPE_GOOGLE_SEARCH", + "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH" + ], + "enumDescriptions": [ + "Default, unspecified setting. This is the same as disabled.", + "Web grounding is disabled.", + "Grounding with Google Search is enabled.", + "Grounding with Enterprise Web Search is enabled." + ], + "type": "string" } }, "type": "object" @@ -23366,6 +23923,10 @@ "description": "Whether or not to enable autocomplete.", "type": "boolean" }, + "enablePeopleSearch": { + "description": "Optional. If set to true, the widget will enable people search.", + "type": "boolean" + }, "enableQualityFeedback": { "description": "Turn on or off collecting the search result quality feedback from end users.", "type": "boolean" @@ -23662,7 +24223,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -24043,6 +24604,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "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": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", "description": "Optional. Configuration for advanced site search." @@ -24451,7 +25016,37 @@ "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -24550,6 +25145,10 @@ ], "type": "string" }, + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, "name": { "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/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" @@ -24649,6 +25248,97 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", + "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "type": "string" + }, + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + }, + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "properties": { + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "type": "string" + }, + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { "description": "Configurations for a Search Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", @@ -25495,6 +26185,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -25535,7 +26229,7 @@ "description": "A specification for configuring the behavior of content search." }, "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.", + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, @@ -25615,13 +26309,13 @@ "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", + "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_backend 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_backend 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", + "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX" ], @@ -25705,7 +26399,7 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "description": "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": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" }, @@ -26430,14 +27124,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -26613,6 +27311,10 @@ "description": "Information of an end user.", "id": "GoogleCloudDiscoveryengineV1betaUserInfo", "properties": { + "timeZone": { + "description": "Optional. IANA time zone, e.g. Europe/Budapest.", + "type": "string" + }, "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" @@ -26691,6 +27393,14 @@ "mediaRequestInfo": { "$ref": "ApiservingMediaRequestInfo", "description": "Media upload request metadata." + }, + "projectId": { + "description": "The project (notebook) id of the uploaded source. Prefer to use the parent field instead.", + "type": "string" + }, + "sourceId": { + "description": "The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created.", + "type": "string" } }, "type": "object" diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index d966f29566d..2b101ff9c15 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -161,6 +161,31 @@ "resources": { "locations": { "methods": { + "getCmekConfig": { + "description": "Gets the CmekConfig.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.getCmekConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "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", @@ -244,9 +269,154 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateCmekConfig": { + "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.updateCmekConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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, + "type": "string" + }, + "setDefault": { + "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { + "cmekConfigs": { + "methods": { + "delete": { + "description": "De-provisions a CmekConfig.", + "flatPath": "v1beta/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": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the CmekConfig.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.cmekConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the CmekConfigs with the project.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.cmekConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/cmekConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.cmekConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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, + "type": "string" + }, + "setDefault": { + "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "collections": { "resources": { "dataConnector": { @@ -7755,7 +7925,7 @@ } } }, - "revision": "20250314", + "revision": "20250425", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -8186,6 +8356,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { + "description": "The specification for answer generation.", + "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "properties": { + "userDefinedClassifierSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", + "description": "Optional. The specification for user specified classifier spec." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": { + "description": "The specification for user defined classifier.", + "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", + "properties": { + "enableUserDefinedClassifier": { + "description": "Optional. Whether or not to enable and include user defined classifier.", + "type": "boolean" + }, + "modelId": { + "description": "Optional. The model id to be used for the user defined classifier.", + "type": "string" + }, + "preamble": { + "description": "Optional. The preamble to be used for the user defined classifier.", + "type": "string" + }, + "seed": { + "description": "Optional. The seed value to be used for the user defined classifier.", + "format": "int32", + "type": "integer" + }, + "taskMarker": { + "description": "Optional. The task marker to be used for the user defined classifier.", + "type": "string" + }, + "temperature": { + "description": "Optional. The temperature value to be used for the user defined classifier.", + "format": "double", + "type": "number" + }, + "topK": { + "description": "Optional. The top-k value to be used for the user defined classifier.", + "format": "int64", + "type": "string" + }, + "topP": { + "description": "Optional. The top-p value to be used for the user defined classifier.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", @@ -8308,7 +8532,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -8672,6 +8896,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "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": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", "description": "Optional. Configuration for advanced site search." @@ -9066,7 +9294,37 @@ "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -9165,6 +9423,10 @@ ], "type": "string" }, + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, "name": { "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/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" @@ -9264,6 +9526,97 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", + "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "type": "string" + }, + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + }, + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "properties": { + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "type": "string" + }, + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { "description": "Configurations for a Search Engine.", "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", @@ -9785,6 +10138,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -9985,6 +10342,10 @@ "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": { + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", + "description": "Optional. The specification for answer generation." + }, "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": { @@ -10237,14 +10598,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -10492,6 +10857,10 @@ "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", "readOnly": true, "type": "boolean" + }, + "serviceName": { + "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", + "type": "string" } }, "type": "object" @@ -10571,7 +10940,8 @@ "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", - "LOW_GROUNDED_ANSWER" + "LOW_GROUNDED_ANSWER", + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -10583,7 +10953,8 @@ "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." + "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." ], "type": "string" }, @@ -10830,14 +11201,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" } @@ -11344,7 +11717,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -11953,6 +12326,10 @@ "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": { + "aclEnabled": { + "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", + "type": "boolean" + }, "actionConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", "description": "Optional. Action configurations to make the connector support actions." @@ -11990,6 +12367,27 @@ "readOnly": true, "type": "array" }, + "connectorModes": { + "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS", + "FEDERATED", + "EUA" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for actions.", + "Connector utilized for federated search.", + "Connector utilized for End User Authentication." + ], + "type": "string" + }, + "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": [ @@ -12002,7 +12400,8 @@ "GOOGLE_CALENDAR", "GOOGLE_DRIVE", "NATIVE_CLOUD_IDENTITY", - "THIRD_PARTY_FEDERATED" + "THIRD_PARTY_FEDERATED", + "THIRD_PARTY_EUA" ], "enumDescriptions": [ "Default value.", @@ -12014,7 +12413,8 @@ "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." + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", + "Connector utilized for End User Authentication features." ], "readOnly": true, "type": "string" @@ -12036,6 +12436,10 @@ }, "type": "array" }, + "endUserConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", + "description": "Optional. Any params and credentials used specifically for EUA connectors." + }, "entities": { "description": "List of entities from the connected data source to ingest.", "items": { @@ -12122,6 +12526,10 @@ "readOnly": true, "type": "string" }, + "realtimeSyncConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", + "description": "Optional. The configuration for realtime sync." + }, "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", @@ -12176,10 +12584,48 @@ ], "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the DataConnector was last updated.", - "format": "google-datetime", - "readOnly": true, + "updateTime": { + "description": "Output only. Timestamp the DataConnector was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { + "description": "Any params and credentials used specifically for EUA connectors.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", + "properties": { + "additionalParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any additional parameters needed for EUA.", + "type": "object" + }, + "authParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Any authentication parameters specific to EUA connectors.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { + "description": "The configuration for realtime sync to store additional params for realtime sync.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", + "properties": { + "realtimeSyncSecret": { + "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", + "type": "string" + }, + "webhookUri": { + "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", "type": "string" } }, @@ -12732,7 +13178,37 @@ "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -12947,6 +13423,10 @@ "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, "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" @@ -12976,6 +13456,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "description": "Custom threshold for `cvr` optimization_objective.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", @@ -12992,6 +13499,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { "description": "Additional information of a recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", @@ -14528,6 +15046,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -14572,7 +15094,7 @@ "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.", + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, @@ -14652,13 +15174,13 @@ "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", + "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_backend 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_backend 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", + "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX" ], @@ -14742,7 +15264,7 @@ "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.", + "description": "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": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, @@ -15570,14 +16092,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -15803,6 +16329,10 @@ "description": "Information of an end user.", "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { + "timeZone": { + "description": "Optional. IANA time zone, e.g. Europe/Budapest.", + "type": "string" + }, "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" @@ -15867,6 +16397,13 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec", "description": "Optional. Specification to boost suggestions matching the condition." }, + "experimentIds": { + "description": "Optional. Experiment ids for this request.", + "items": { + "type": "string" + }, + "type": "array" + }, "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" @@ -15925,7 +16462,7 @@ "id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec", "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.", + "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifications, 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": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec" }, @@ -16227,7 +16764,8 @@ "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", - "LOW_GROUNDED_ANSWER" + "LOW_GROUNDED_ANSWER", + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -16239,7 +16777,8 @@ "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." + "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." ], "type": "string" }, @@ -16424,6 +16963,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec": { + "description": "The specification for answer generation.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec", + "properties": { + "userDefinedClassifierSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec", + "description": "Optional. The specification for user specified classifier spec." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec": { + "description": "The specification for user defined classifier.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec", + "properties": { + "enableUserDefinedClassifier": { + "description": "Optional. Whether or not to enable and include user defined classifier.", + "type": "boolean" + }, + "modelId": { + "description": "Optional. The model id to be used for the user defined classifier.", + "type": "string" + }, + "preamble": { + "description": "Optional. The preamble to be used for the user defined classifier.", + "type": "string" + }, + "seed": { + "description": "Optional. The seed value to be used for the user defined classifier.", + "format": "int32", + "type": "integer" + }, + "taskMarker": { + "description": "Optional. The task marker to be used for the user defined classifier.", + "type": "string" + }, + "temperature": { + "description": "Optional. The temperature value to be used for the user defined classifier.", + "format": "double", + "type": "number" + }, + "topK": { + "description": "Optional. The top-k value to be used for the user defined classifier.", + "format": "int64", + "type": "string" + }, + "topP": { + "description": "Optional. The top-p value to be used for the user defined classifier.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport": { "description": "Grounding support for a claim in `answer_text`.", "id": "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport", @@ -16711,14 +17304,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" }, @@ -17105,14 +17700,16 @@ "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "NON_ANSWER_SEEKING_QUERY_V2", + "USER_DEFINED_CLASSIFICATION_QUERY" ], "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." + "Non-answer-seeking query classification type, for no clear intent.", + "User defined query classification type." ], "type": "string" } @@ -17843,6 +18440,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.", "type": "boolean" }, + "score": { + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true.", + "format": "double", + "type": "number" + }, "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", @@ -17859,6 +18461,10 @@ "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" + }, + "enableClaimLevelScore": { + "description": "The control flag that enables claim-level grounding score in the response.", + "type": "boolean" } }, "type": "object" @@ -17867,6 +18473,14 @@ "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", "id": "GoogleCloudDiscoveryengineV1betaChunk", "properties": { + "annotationContents": { + "description": "Output only. Annotation contents if the current chunk contains annotations.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "chunkMetadata": { "$ref": "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata", "description": "Output only. Metadata of the current chunk.", @@ -17876,6 +18490,14 @@ "description": "Content is a string from a document (parsed content).", "type": "string" }, + "dataUrls": { + "description": "Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "derivedStructData": { "additionalProperties": { "description": "Properties of the object.", @@ -18186,7 +18808,7 @@ "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.", + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "queryTerms": { @@ -18829,6 +19451,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "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": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", "description": "Optional. Configuration for advanced site search." @@ -19166,9 +19792,13 @@ "description": "Document captures all raw metadata information of items to be recommended or searched.", "id": "GoogleCloudDiscoveryengineV1betaDocument", "properties": { + "aclInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentAclInfo", + "description": "Access control information for the document." + }, "content": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentContent", - "description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store." + "description": "The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store." }, "derivedStructData": { "additionalProperties": { @@ -19221,12 +19851,44 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentAclInfo": { + "description": "ACL Information of the Document.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentAclInfo", + "properties": { + "readers": { + "description": "Readers of the document.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction": { + "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": "GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction", + "properties": { + "idpWide": { + "description": "All users within the Identity Provider.", + "type": "boolean" + }, + "principals": { + "description": "List of principals.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaPrincipal" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentContent": { "description": "Unstructured data linked to this document.", "id": "GoogleCloudDiscoveryengineV1betaDocumentContent", "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.", + "description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, "rawBytes": { @@ -19386,7 +20048,37 @@ "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, + "properties": { + "enableImageAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", + "type": "boolean" + }, + "excludeHtmlClasses": { + "description": "Optional. List of HTML classes to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlElements": { + "description": "Optional. List of HTML elements to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludeHtmlIds": { + "description": "Optional. List of HTML ids to exclude from the parsed content.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { @@ -19517,6 +20209,10 @@ ], "type": "string" }, + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, "name": { "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/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" @@ -19616,6 +20312,97 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", + "properties": { + "engineFeaturesConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "description": "Optional. Additional engine features config." + }, + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "type": "string" + }, + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + }, + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { + "description": "More feature configs of the selected engine type.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", + "properties": { + "mostPopularConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "description": "Most popular engine feature config." + }, + "recommendedForYouConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "description": "Recommended for you engine feature config." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { + "description": "Feature configurations that are required for creating a Most Popular engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", + "properties": { + "timeWindowDays": { + "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "properties": { + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "type": "string" + }, + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { + "description": "Additional feature configurations for creating a `recommended-for-you` engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", + "properties": { + "contextEventType": { + "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { "description": "Configurations for a Search Engine.", "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", @@ -19750,6 +20537,10 @@ "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" }, + "domain": { + "description": "The domain of the source.", + "type": "string" + }, "index": { "description": "The index of this chunk. Currently, only used for the streaming mode.", "format": "int32", @@ -19765,6 +20556,14 @@ }, "description": "More fine-grained information for the source reference.", "type": "object" + }, + "title": { + "description": "The title of the source.", + "type": "string" + }, + "uri": { + "description": "The URI of the source.", + "type": "string" } }, "type": "object" @@ -20554,6 +21353,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse": { + "description": "Response message for CmekConfigService.ListCmekConfigs method.", + "id": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse", + "properties": { + "cmekConfigs": { + "description": "All the customer's CmekConfigs.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaListControlsResponse": { "description": "Response for ListControls method.", "id": "GoogleCloudDiscoveryengineV1betaListControlsResponse", @@ -21019,6 +21832,21 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaPrincipal": { + "description": "Principal identifier of a user or a group.", + "id": "GoogleCloudDiscoveryengineV1betaPrincipal", + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", @@ -21930,6 +22758,10 @@ "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, + "document": { + "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", + "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" @@ -21970,7 +22802,7 @@ "description": "A specification for configuring the behavior of content search." }, "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.", + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, @@ -22050,13 +22882,13 @@ "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", + "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_backend 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_backend 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", + "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX" ], @@ -22140,7 +22972,7 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "description": "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": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" }, @@ -23464,6 +24296,10 @@ "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": "GoogleCloudDiscoveryengineV1betaServingConfig", "properties": { + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec", + "description": "Optional. The specification for answer generation." + }, "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": { @@ -23948,14 +24784,18 @@ "PENDING", "FAILED", "SUCCEEDED", - "DELETING" + "DELETING", + "CANCELLABLE", + "CANCELLED" ], "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." + "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.", + "The target site change is pending but cancellable.", + "The target site change is cancelled." ], "readOnly": true, "type": "string" @@ -24344,6 +25184,10 @@ "description": "Information of an end user.", "id": "GoogleCloudDiscoveryengineV1betaUserInfo", "properties": { + "timeZone": { + "description": "Optional. IANA time zone, e.g. Europe/Budapest.", + "type": "string" + }, "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" diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index 8743510d958..00551060db6 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. *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).", + "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.", "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. *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).", + "description": "Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.", "flatPath": "v2/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.scripts.create", @@ -7350,7 +7350,7 @@ "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.", + "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 `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty.", "flatPath": "v2/sdfdownloadtasks", "httpMethod": "POST", "id": "displayvideo.sdfdownloadtasks.create", @@ -8010,7 +8010,7 @@ } } }, - "revision": "20250313", + "revision": "20250424", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -8164,11 +8164,11 @@ "type": "object" }, "Adloox": { - "description": "Details of Adloox brand safety settings.", + "description": "Details of Scope3 (previously known as Adloox) brand safety settings.", "id": "Adloox", "properties": { "excludedAdlooxCategories": { - "description": "Adloox categories to exclude.", + "description": "Scope3 categories to exclude.", "items": { "enum": [ "ADLOOX_UNSPECIFIED", @@ -8182,7 +8182,7 @@ "FRAUD" ], "enumDescriptions": [ - "Default value when a Adloox category is not specified or is unknown in this version.", + "Default value when a Scope3 category is not specified or is unknown in this version.", "Adult content (hard).", "Adult content (soft).", "Illegal content.", @@ -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. *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).", + "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. This field can't be updated if 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.", "items": { "$ref": "TrackingFloodlightActivityConfig" }, @@ -10950,7 +10950,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -10967,6 +10968,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -10984,7 +10986,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -12692,6 +12695,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -12779,6 +12784,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -12891,6 +12898,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -12978,6 +12987,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -13091,6 +13102,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -13178,6 +13191,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -13292,6 +13307,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -13379,6 +13396,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "readOnly": true, @@ -14136,6 +14155,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -14223,6 +14244,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -15053,6 +15076,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -15140,6 +15165,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -15627,7 +15654,7 @@ }, "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)." + "description": "The conversion tracking setting of the line item." }, "creativeIds": { "description": "The IDs of the creatives associated with the line item.", @@ -16669,7 +16696,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`. *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).", + "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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.", "format": "int64", "type": "string" }, @@ -17407,7 +17434,6 @@ "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", @@ -17417,8 +17443,8 @@ ], "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 Scope3 (previously known as Adloox). Billed by the partner.", + "The cost is charged for using Scope3 (previously known as 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.", @@ -17440,7 +17466,6 @@ "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.", @@ -17617,7 +17642,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`. *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).", + "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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.", "format": "int64", "type": "string" }, @@ -18176,7 +18201,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -18193,6 +18219,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -18210,7 +18237,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -18218,7 +18246,7 @@ "type": "object" }, "SdfDownloadTask": { - "description": "Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "description": "Type for the response returned by SdfDownloadTaskService.CreateSdfDownloadTask.", "id": "SdfDownloadTask", "properties": { "resourceName": { @@ -18229,7 +18257,7 @@ "type": "object" }, "SdfDownloadTaskMetadata": { - "description": "Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "description": "Type for the metadata returned by SdfDownloadTaskService.CreateSdfDownloadTask.", "id": "SdfDownloadTaskMetadata", "properties": { "createTime": { @@ -18259,7 +18287,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -18276,6 +18305,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -18293,7 +18323,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -19003,7 +19034,7 @@ "properties": { "adloox": { "$ref": "Adloox", - "description": "Third party brand verifier -- Adloox." + "description": "Third party brand verifier -- Scope3 (previously known as Adloox)." }, "doubleVerify": { "$ref": "DoubleVerify", diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index 1d02b18dc72..a06a906efce 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -690,7 +690,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -741,7 +742,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -856,7 +858,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -907,7 +910,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -1319,7 +1323,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -1370,7 +1375,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -1485,7 +1491,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -1536,7 +1543,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -2499,7 +2507,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -2550,7 +2559,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -2655,7 +2665,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -2706,7 +2717,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -2808,7 +2820,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -2859,7 +2872,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -2974,7 +2988,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -3025,7 +3040,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -3596,7 +3612,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -3647,7 +3664,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -3752,7 +3770,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -3803,7 +3822,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -3905,7 +3925,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -3956,7 +3977,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -4071,7 +4093,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -4122,7 +4145,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -4948,7 +4972,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -4999,7 +5024,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -5095,7 +5121,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -5146,7 +5173,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -5239,7 +5267,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -5290,7 +5319,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -5396,7 +5426,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -5447,7 +5478,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -5668,7 +5700,7 @@ ] }, "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).", + "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}", "httpMethod": "PATCH", "id": "displayvideo.customBiddingAlgorithms.patch", @@ -5783,7 +5815,7 @@ "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).", + "description": "Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error.", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.rules.create", @@ -5929,7 +5961,7 @@ "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).", + "description": "Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.scripts.create", @@ -8038,7 +8070,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -8089,7 +8122,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -8185,7 +8219,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -8236,7 +8271,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -8329,7 +8365,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -8380,7 +8417,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -8486,7 +8524,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -8537,7 +8576,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -8562,7 +8602,7 @@ "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.", + "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 `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty.", "flatPath": "v3/sdfdownloadtasks", "httpMethod": "POST", "id": "displayvideo.sdfdownloadtasks.create", @@ -8613,40 +8653,6 @@ } } }, - "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": { @@ -8725,7 +8731,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -8776,7 +8783,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -8879,7 +8887,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -8930,7 +8939,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -9006,7 +9016,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -9057,7 +9068,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -9256,7 +9268,7 @@ } } }, - "revision": "20250313", + "revision": "20250424", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9597,7 +9609,7 @@ "type": "object" }, "Adloox": { - "description": "Details of Adloox brand safety settings.", + "description": "Details of Scope3 (previously known as Adloox) brand safety settings.", "id": "Adloox", "properties": { "adultExplicitSexualContent": { @@ -9711,7 +9723,7 @@ "type": "string" }, "excludedAdlooxCategories": { - "description": "Adloox categories to exclude.", + "description": "Scope3 categories to exclude.", "items": { "enum": [ "ADLOOX_UNSPECIFIED", @@ -9725,7 +9737,7 @@ "FRAUD" ], "enumDescriptions": [ - "Default value when a Adloox category is not specified or is unknown in this version.", + "Default value when a Scope3 category is not specified or is unknown in this version.", "Adult content (hard).", "Adult content (soft).", "Illegal content.", @@ -9740,14 +9752,14 @@ "type": "array" }, "excludedFraudIvtMfaCategories": { - "description": "Optional. Adloox's fraud IVT MFA categories to exclude.", + "description": "Optional. Scope3'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.", + "Default value when a Scope3 Fraud, IVT, MFA category is not specified or is unknown in this version.", "FRAUD, IVT, MFA." ], "type": "string" @@ -10203,9 +10215,18 @@ "description": "Rule-based algorithm.", "id": "AlgorithmRules", "properties": { + "attributionModelId": { + "description": "Attribution model for the algorithm.", + "format": "int64", + "type": "string" + }, "impressionSignalRuleset": { "$ref": "AlgorithmRulesRuleset", "description": "Rules for the impression signals." + }, + "postImpressionSignalRuleset": { + "$ref": "AlgorithmRulesRuleset", + "description": "Rules for the post-impression signals." } }, "type": "object" @@ -10356,6 +10377,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -10443,6 +10466,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -10471,6 +10496,70 @@ "stringValue": { "description": "String value.", "type": "string" + }, + "videoPlayerSizeValue": { + "description": "Video player size value.", + "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" + }, + "AlgorithmRulesFloodlightActivityConversionSignal": { + "description": "The rule to score impressions based on Floodlight conversion events.", + "id": "AlgorithmRulesFloodlightActivityConversionSignal", + "properties": { + "conversionCounting": { + "description": "Required. The type of conversions to be used in impression value computation, for example, post-click conversions.", + "enum": [ + "CONVERSION_COUNTING_UNSPECIFIED", + "ALL_CONVERSIONS", + "POST_CLICK", + "POST_VIEW" + ], + "enumDescriptions": [ + "The action is not specified.", + "All conversions.", + "Post-click conversions.", + "Post-view conversions." + ], + "type": "string" + }, + "countingMethod": { + "description": "Required. The way to acquire value from the floodlight activity, for example, count of the conversion.", + "enum": [ + "COUNTING_METHOD_UNSPECIFIED", + "CONVERSIONS_COUNT", + "SALES_QUANTITY", + "SALES_VALUE", + "UNIQUE_COUNT" + ], + "enumDescriptions": [ + "The action is not specified.", + "The count of conversions associated with the conversion activity.", + "The number of sales items associated with the conversion activity.", + "The sales revenue associated with the conversion activity.", + "The count of unique conversions associated with the conversion activity. Only one conversion can be counted per impression." + ], + "type": "string" + }, + "floodlightActivityId": { + "description": "Required. Id of the floodlight activity.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -10550,6 +10639,40 @@ "description": "Signal used to evaluate rules.", "id": "AlgorithmRulesSignal", "properties": { + "activeViewSignal": { + "description": "Signal based on active views.", + "enum": [ + "ACTIVE_VIEW_SIGNAL_UNSPECIFIED", + "ACTIVE_VIEW_VIEWED", + "AUDIBLE", + "VIDEO_COMPLETED", + "TIME_ON_SCREEN", + "VIDEO_PLAYER_SIZE", + "COMPLETED_IN_VIEW_AUDIBLE" + ], + "enumDescriptions": [ + "Unknown signal.", + "Whether Active View detects that your ad has been viewed. Value is stored in the boolValue field of the comparison value.", + "Whether Active View detects that your ad was audible. Value is stored in the boolValue field of the comparison value.", + "Whether the video was completed. Value is stored in the boolValue field of the comparison value.", + "The time the ad was on screen in seconds. Value is stored in the int64Value field of the comparison value.", + "The size of the video player displaying the ad. Value is stored in the videoPlayerSizeValue field of the comparison value.", + "Whether the ad was completed in view and audible. Value is stored in the boolValue field of the comparison value." + ], + "type": "string" + }, + "clickSignal": { + "description": "Signal based on clicks.", + "enum": [ + "CLICK_SIGNAL_UNSPECIFIED", + "CLICK" + ], + "enumDescriptions": [ + "Unknown signal.", + "Whether the ad was clicked. Value is stored in the boolValue field of the comparison value." + ], + "type": "string" + }, "impressionSignal": { "description": "Signal based on impressions.", "enum": [ @@ -10624,6 +10747,32 @@ "description": "Adjusted value of the signal used for rule evaluation.", "id": "AlgorithmRulesSignalValue", "properties": { + "activeViewSignal": { + "description": "Signal based on active views. Only `TIME_ON_SCREEN` is supported.", + "enum": [ + "ACTIVE_VIEW_SIGNAL_UNSPECIFIED", + "ACTIVE_VIEW_VIEWED", + "AUDIBLE", + "VIDEO_COMPLETED", + "TIME_ON_SCREEN", + "VIDEO_PLAYER_SIZE", + "COMPLETED_IN_VIEW_AUDIBLE" + ], + "enumDescriptions": [ + "Unknown signal.", + "Whether Active View detects that your ad has been viewed. Value is stored in the boolValue field of the comparison value.", + "Whether Active View detects that your ad was audible. Value is stored in the boolValue field of the comparison value.", + "Whether the video was completed. Value is stored in the boolValue field of the comparison value.", + "The time the ad was on screen in seconds. Value is stored in the int64Value field of the comparison value.", + "The size of the video player displaying the ad. Value is stored in the videoPlayerSizeValue field of the comparison value.", + "Whether the ad was completed in view and audible. Value is stored in the boolValue field of the comparison value." + ], + "type": "string" + }, + "floodlightActivityConversionSignal": { + "$ref": "AlgorithmRulesFloodlightActivityConversionSignal", + "description": "Signal based on floodlight conversion events." + }, "number": { "description": "Value to use as result.", "format": "double", @@ -10919,6 +11068,10 @@ "$ref": "ContentStreamTypeAssignedTargetingOptionDetails", "description": "Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`." }, + "contentThemeExclusionDetails": { + "$ref": "ContentThemeAssignedTargetingOptionDetails", + "description": "Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions." + }, "dayAndTimeDetails": { "$ref": "DayAndTimeAssignedTargetingOptionDetails", "description": "Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`." @@ -11092,7 +11245,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -11143,7 +11297,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "readOnly": true, "type": "string" @@ -13026,12 +13181,116 @@ }, "type": "object" }, + "ContentThemeAssignedTargetingOptionDetails": { + "description": "Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`.", + "id": "ContentThemeAssignedTargetingOptionDetails", + "properties": { + "contentTheme": { + "description": "Output only. An enum for the DV360 content theme classifier.", + "enum": [ + "CONTENT_THEME_UNSPECIFIED", + "CONTENT_THEME_FIGHTING_VIDEO_GAMES", + "CONTENT_THEME_MATURE_GAMES", + "CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES", + "CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES", + "CONTENT_THEME_POLITICS", + "CONTENT_THEME_RECENT_NEWS", + "CONTENT_THEME_RELIGION", + "CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT", + "CONTENT_THEME_UNPLEASANT_NEWS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 content theme.", + "Fighting video games.", + "Mature games.", + "Not yet determined health sources.", + "Not yet determined news sources.", + "Politics.", + "Recent news.", + "Religion.", + "Unpleasant health content.", + "Unpleasant news." + ], + "readOnly": true, + "type": "string" + }, + "excludedContentTheme": { + "description": "Required. An enum for the DV360 content theme classified to be EXCLUDED.", + "enum": [ + "CONTENT_THEME_UNSPECIFIED", + "CONTENT_THEME_FIGHTING_VIDEO_GAMES", + "CONTENT_THEME_MATURE_GAMES", + "CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES", + "CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES", + "CONTENT_THEME_POLITICS", + "CONTENT_THEME_RECENT_NEWS", + "CONTENT_THEME_RELIGION", + "CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT", + "CONTENT_THEME_UNPLEASANT_NEWS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 content theme.", + "Fighting video games.", + "Mature games.", + "Not yet determined health sources.", + "Not yet determined news sources.", + "Politics.", + "Recent news.", + "Religion.", + "Unpleasant health content.", + "Unpleasant news." + ], + "type": "string" + }, + "excludedTargetingOptionId": { + "description": "Required. ID of the content theme to be EXCLUDED.", + "type": "string" + } + }, + "type": "object" + }, + "ContentThemeTargetingOptionDetails": { + "description": "Represents a targetable content theme. This will be populated in the content_theme_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`.", + "id": "ContentThemeTargetingOptionDetails", + "properties": { + "contentTheme": { + "description": "Output only. An enum for the DV360 content theme content classifier.", + "enum": [ + "CONTENT_THEME_UNSPECIFIED", + "CONTENT_THEME_FIGHTING_VIDEO_GAMES", + "CONTENT_THEME_MATURE_GAMES", + "CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES", + "CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES", + "CONTENT_THEME_POLITICS", + "CONTENT_THEME_RECENT_NEWS", + "CONTENT_THEME_RELIGION", + "CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT", + "CONTENT_THEME_UNPLEASANT_NEWS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 content theme.", + "Fighting video games.", + "Mature games.", + "Not yet determined health sources.", + "Not yet determined news sources.", + "Politics.", + "Recent news.", + "Religion.", + "Unpleasant health content.", + "Unpleasant news." + ], + "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).", + "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. This field can't be updated if 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.", "items": { "$ref": "TrackingFloodlightActivityConfig" }, @@ -13144,7 +13403,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -13195,7 +13455,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "type": "string" } @@ -13245,7 +13506,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -13262,6 +13524,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -13279,7 +13542,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -14295,7 +14559,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -14346,7 +14611,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "type": "string" } @@ -15179,6 +15445,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -15266,6 +15534,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -15378,6 +15648,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -15465,6 +15737,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -15578,6 +15852,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -15665,6 +15941,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -15779,6 +16057,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -15866,6 +16146,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "readOnly": true, @@ -16044,7 +16326,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` *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).", + "description": "The duration in days that an entry remains in the audience after the qualifying event. 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`", "format": "int64", "type": "string" }, @@ -16876,6 +17158,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -16963,6 +17247,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -17815,6 +18101,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -17902,6 +18190,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -18465,7 +18755,7 @@ }, "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)." + "description": "The conversion tracking setting of the line item." }, "creativeIds": { "description": "The IDs of the creatives associated with the line item.", @@ -19504,7 +19794,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`. *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).", + "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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.", "format": "int64", "type": "string" }, @@ -20288,10 +20578,43 @@ "PARTNER_COST_TYPE_CUSTOM_FEE_5", "PARTNER_COST_TYPE_SCIBIDS_FEE" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false + ], "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 Scope3 (previously known as Adloox). Billed by the partner.", + "The cost is charged for using Scope3 (previously known as 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.", @@ -20490,7 +20813,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`. *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).", + "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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.", "format": "int64", "type": "string" }, @@ -21049,7 +21372,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -21066,6 +21390,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21083,7 +21408,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -21091,7 +21417,7 @@ "type": "object" }, "SdfDownloadTask": { - "description": "Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "description": "Type for the response returned by SdfDownloadTaskService.CreateSdfDownloadTask.", "id": "SdfDownloadTask", "properties": { "resourceName": { @@ -21102,7 +21428,7 @@ "type": "object" }, "SdfDownloadTaskMetadata": { - "description": "Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "description": "Type for the metadata returned by SdfDownloadTaskService.CreateSdfDownloadTask.", "id": "SdfDownloadTaskMetadata", "properties": { "createTime": { @@ -21132,7 +21458,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -21149,6 +21476,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21166,7 +21494,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -21559,6 +21888,10 @@ "$ref": "ContentStreamTypeTargetingOptionDetails", "description": "Content stream type resource details." }, + "contentThemeDetails": { + "$ref": "ContentThemeTargetingOptionDetails", + "description": "Content theme details." + }, "deviceMakeModelDetails": { "$ref": "DeviceMakeModelTargetingOptionDetails", "description": "Device make and model resource details." @@ -21688,7 +22021,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -21739,7 +22073,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "readOnly": true, "type": "string" @@ -21903,7 +22238,7 @@ "properties": { "adloox": { "$ref": "Adloox", - "description": "Third party brand verifier -- Adloox." + "description": "Third party brand verifier -- Scope3 (previously known as Adloox)." }, "doubleVerify": { "$ref": "DoubleVerify", diff --git a/discovery/displayvideo-v4.json b/discovery/displayvideo-v4.json index 4a1d0d2994c..e76c5ab2fdf 100644 --- a/discovery/displayvideo-v4.json +++ b/discovery/displayvideo-v4.json @@ -690,7 +690,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -741,7 +742,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -856,7 +858,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -907,7 +910,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -2525,7 +2529,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -2576,7 +2581,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -2681,7 +2687,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -2732,7 +2739,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -2834,7 +2842,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -2885,7 +2894,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -3000,7 +3010,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -3051,7 +3062,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -3877,7 +3889,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -3928,7 +3941,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -4024,7 +4038,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -4075,7 +4090,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -4168,7 +4184,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -4219,7 +4236,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -4325,7 +4343,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -4376,7 +4395,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -4597,7 +4617,7 @@ ] }, "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).", + "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.", "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}", "httpMethod": "PATCH", "id": "displayvideo.customBiddingAlgorithms.patch", @@ -4712,7 +4732,7 @@ "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).", + "description": "Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error.", "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.rules.create", @@ -4858,7 +4878,7 @@ "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).", + "description": "Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.", "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.scripts.create", @@ -6967,7 +6987,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -7018,7 +7039,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -7114,7 +7136,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -7165,7 +7188,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -7258,7 +7282,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -7309,7 +7334,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -7415,7 +7441,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -7466,7 +7493,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -7491,7 +7519,7 @@ "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.", + "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 `sdfdownloadtasks.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", @@ -7654,7 +7682,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -7705,7 +7734,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -7808,7 +7838,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -7859,7 +7890,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -7935,7 +7967,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -7986,7 +8019,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "location": "path", "pattern": "^[^/]+$", @@ -8185,7 +8219,7 @@ } } }, - "revision": "20250313", + "revision": "20250424", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -8526,7 +8560,7 @@ "type": "object" }, "Adloox": { - "description": "Details of Adloox brand safety settings.", + "description": "Details of Scope3 (previously known as Adloox) brand safety settings.", "id": "Adloox", "properties": { "adultExplicitSexualContent": { @@ -8640,7 +8674,7 @@ "type": "string" }, "excludedAdlooxCategories": { - "description": "Adloox categories to exclude.", + "description": "Scope3 categories to exclude.", "items": { "enum": [ "ADLOOX_UNSPECIFIED", @@ -8654,7 +8688,7 @@ "FRAUD" ], "enumDescriptions": [ - "Default value when a Adloox category is not specified or is unknown in this version.", + "Default value when a Scope3 category is not specified or is unknown in this version.", "Adult content (hard).", "Adult content (soft).", "Illegal content.", @@ -8669,14 +8703,14 @@ "type": "array" }, "excludedFraudIvtMfaCategories": { - "description": "Optional. Adloox's fraud IVT MFA categories to exclude.", + "description": "Optional. Scope3'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.", + "Default value when a Scope3 Fraud, IVT, MFA category is not specified or is unknown in this version.", "FRAUD, IVT, MFA." ], "type": "string" @@ -9132,9 +9166,18 @@ "description": "Rule-based algorithm.", "id": "AlgorithmRules", "properties": { + "attributionModelId": { + "description": "Attribution model for the algorithm.", + "format": "int64", + "type": "string" + }, "impressionSignalRuleset": { "$ref": "AlgorithmRulesRuleset", "description": "Rules for the impression signals." + }, + "postImpressionSignalRuleset": { + "$ref": "AlgorithmRulesRuleset", + "description": "Rules for the post-impression signals." } }, "type": "object" @@ -9285,6 +9328,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -9372,6 +9417,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -9400,6 +9447,70 @@ "stringValue": { "description": "String value.", "type": "string" + }, + "videoPlayerSizeValue": { + "description": "Video player size value.", + "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" + }, + "AlgorithmRulesFloodlightActivityConversionSignal": { + "description": "The rule to score impressions based on Floodlight conversion events.", + "id": "AlgorithmRulesFloodlightActivityConversionSignal", + "properties": { + "conversionCounting": { + "description": "Required. The type of conversions to be used in impression value computation, for example, post-click conversions.", + "enum": [ + "CONVERSION_COUNTING_UNSPECIFIED", + "ALL_CONVERSIONS", + "POST_CLICK", + "POST_VIEW" + ], + "enumDescriptions": [ + "The action is not specified.", + "All conversions.", + "Post-click conversions.", + "Post-view conversions." + ], + "type": "string" + }, + "countingMethod": { + "description": "Required. The way to acquire value from the floodlight activity, for example, count of the conversion.", + "enum": [ + "COUNTING_METHOD_UNSPECIFIED", + "CONVERSIONS_COUNT", + "SALES_QUANTITY", + "SALES_VALUE", + "UNIQUE_COUNT" + ], + "enumDescriptions": [ + "The action is not specified.", + "The count of conversions associated with the conversion activity.", + "The number of sales items associated with the conversion activity.", + "The sales revenue associated with the conversion activity.", + "The count of unique conversions associated with the conversion activity. Only one conversion can be counted per impression." + ], + "type": "string" + }, + "floodlightActivityId": { + "description": "Required. Id of the floodlight activity.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -9479,6 +9590,40 @@ "description": "Signal used to evaluate rules.", "id": "AlgorithmRulesSignal", "properties": { + "activeViewSignal": { + "description": "Signal based on active views.", + "enum": [ + "ACTIVE_VIEW_SIGNAL_UNSPECIFIED", + "ACTIVE_VIEW_VIEWED", + "AUDIBLE", + "VIDEO_COMPLETED", + "TIME_ON_SCREEN", + "VIDEO_PLAYER_SIZE", + "COMPLETED_IN_VIEW_AUDIBLE" + ], + "enumDescriptions": [ + "Unknown signal.", + "Whether Active View detects that your ad has been viewed. Value is stored in the boolValue field of the comparison value.", + "Whether Active View detects that your ad was audible. Value is stored in the boolValue field of the comparison value.", + "Whether the video was completed. Value is stored in the boolValue field of the comparison value.", + "The time the ad was on screen in seconds. Value is stored in the int64Value field of the comparison value.", + "The size of the video player displaying the ad. Value is stored in the videoPlayerSizeValue field of the comparison value.", + "Whether the ad was completed in view and audible. Value is stored in the boolValue field of the comparison value." + ], + "type": "string" + }, + "clickSignal": { + "description": "Signal based on clicks.", + "enum": [ + "CLICK_SIGNAL_UNSPECIFIED", + "CLICK" + ], + "enumDescriptions": [ + "Unknown signal.", + "Whether the ad was clicked. Value is stored in the boolValue field of the comparison value." + ], + "type": "string" + }, "impressionSignal": { "description": "Signal based on impressions.", "enum": [ @@ -9553,6 +9698,32 @@ "description": "Adjusted value of the signal used for rule evaluation.", "id": "AlgorithmRulesSignalValue", "properties": { + "activeViewSignal": { + "description": "Signal based on active views. Only `TIME_ON_SCREEN` is supported.", + "enum": [ + "ACTIVE_VIEW_SIGNAL_UNSPECIFIED", + "ACTIVE_VIEW_VIEWED", + "AUDIBLE", + "VIDEO_COMPLETED", + "TIME_ON_SCREEN", + "VIDEO_PLAYER_SIZE", + "COMPLETED_IN_VIEW_AUDIBLE" + ], + "enumDescriptions": [ + "Unknown signal.", + "Whether Active View detects that your ad has been viewed. Value is stored in the boolValue field of the comparison value.", + "Whether Active View detects that your ad was audible. Value is stored in the boolValue field of the comparison value.", + "Whether the video was completed. Value is stored in the boolValue field of the comparison value.", + "The time the ad was on screen in seconds. Value is stored in the int64Value field of the comparison value.", + "The size of the video player displaying the ad. Value is stored in the videoPlayerSizeValue field of the comparison value.", + "Whether the ad was completed in view and audible. Value is stored in the boolValue field of the comparison value." + ], + "type": "string" + }, + "floodlightActivityConversionSignal": { + "$ref": "AlgorithmRulesFloodlightActivityConversionSignal", + "description": "Signal based on floodlight conversion events." + }, "number": { "description": "Value to use as result.", "format": "double", @@ -9848,6 +10019,10 @@ "$ref": "ContentStreamTypeAssignedTargetingOptionDetails", "description": "Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`." }, + "contentThemeExclusionDetails": { + "$ref": "ContentThemeAssignedTargetingOptionDetails", + "description": "Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions." + }, "dayAndTimeDetails": { "$ref": "DayAndTimeAssignedTargetingOptionDetails", "description": "Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`." @@ -10021,7 +10196,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -10072,7 +10248,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "readOnly": true, "type": "string" @@ -11921,12 +12098,116 @@ }, "type": "object" }, + "ContentThemeAssignedTargetingOptionDetails": { + "description": "Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`.", + "id": "ContentThemeAssignedTargetingOptionDetails", + "properties": { + "contentTheme": { + "description": "Output only. An enum for the DV360 content theme classifier.", + "enum": [ + "CONTENT_THEME_UNSPECIFIED", + "CONTENT_THEME_FIGHTING_VIDEO_GAMES", + "CONTENT_THEME_MATURE_GAMES", + "CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES", + "CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES", + "CONTENT_THEME_POLITICS", + "CONTENT_THEME_RECENT_NEWS", + "CONTENT_THEME_RELIGION", + "CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT", + "CONTENT_THEME_UNPLEASANT_NEWS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 content theme.", + "Fighting video games.", + "Mature games.", + "Not yet determined health sources.", + "Not yet determined news sources.", + "Politics.", + "Recent news.", + "Religion.", + "Unpleasant health content.", + "Unpleasant news." + ], + "readOnly": true, + "type": "string" + }, + "excludedContentTheme": { + "description": "Required. An enum for the DV360 content theme classified to be EXCLUDED.", + "enum": [ + "CONTENT_THEME_UNSPECIFIED", + "CONTENT_THEME_FIGHTING_VIDEO_GAMES", + "CONTENT_THEME_MATURE_GAMES", + "CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES", + "CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES", + "CONTENT_THEME_POLITICS", + "CONTENT_THEME_RECENT_NEWS", + "CONTENT_THEME_RELIGION", + "CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT", + "CONTENT_THEME_UNPLEASANT_NEWS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 content theme.", + "Fighting video games.", + "Mature games.", + "Not yet determined health sources.", + "Not yet determined news sources.", + "Politics.", + "Recent news.", + "Religion.", + "Unpleasant health content.", + "Unpleasant news." + ], + "type": "string" + }, + "excludedTargetingOptionId": { + "description": "Required. ID of the content theme to be EXCLUDED.", + "type": "string" + } + }, + "type": "object" + }, + "ContentThemeTargetingOptionDetails": { + "description": "Represents a targetable content theme. This will be populated in the content_theme_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`.", + "id": "ContentThemeTargetingOptionDetails", + "properties": { + "contentTheme": { + "description": "Output only. An enum for the DV360 content theme content classifier.", + "enum": [ + "CONTENT_THEME_UNSPECIFIED", + "CONTENT_THEME_FIGHTING_VIDEO_GAMES", + "CONTENT_THEME_MATURE_GAMES", + "CONTENT_THEME_NOT_YET_DETERMINED_HEALTH_SOURCES", + "CONTENT_THEME_NOT_YET_DETERMINED_NEWS_SOURCES", + "CONTENT_THEME_POLITICS", + "CONTENT_THEME_RECENT_NEWS", + "CONTENT_THEME_RELIGION", + "CONTENT_THEME_UNPLEASANT_HEALTH_CONTENT", + "CONTENT_THEME_UNPLEASANT_NEWS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 content theme.", + "Fighting video games.", + "Mature games.", + "Not yet determined health sources.", + "Not yet determined news sources.", + "Politics.", + "Recent news.", + "Religion.", + "Unpleasant health content.", + "Unpleasant news." + ], + "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).", + "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. This field can't be updated if 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.", "items": { "$ref": "TrackingFloodlightActivityConfig" }, @@ -12039,7 +12320,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -12090,7 +12372,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "type": "string" } @@ -12140,7 +12423,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -12157,6 +12441,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -12174,7 +12459,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -13179,7 +13465,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -13230,7 +13517,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "type": "string" } @@ -14063,6 +14351,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -14150,6 +14440,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -14262,6 +14554,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -14349,6 +14643,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -14462,6 +14758,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -14549,6 +14847,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -14663,6 +14963,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -14750,6 +15052,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "readOnly": true, @@ -14937,7 +15241,7 @@ "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).", + "description": "Output only. The duration in days that an entry remains in the audience after the qualifying event. 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`", "format": "int64", "readOnly": true, "type": "string" @@ -15770,6 +16074,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -15857,6 +16163,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -16709,6 +17017,8 @@ "EXCHANGE_TOPON_GBID", "EXCHANGE_NETFLIX", "EXCHANGE_CORE", + "EXCHANGE_COMMERCE_GRID", + "EXCHANGE_SPOTIFY", "EXCHANGE_TUBI" ], "enumDescriptions": [ @@ -16796,6 +17106,8 @@ "TopOn.", "Netflix.", "Core.", + "Commerce Grid.", + "Spotify.", "Tubi." ], "type": "string" @@ -17359,7 +17671,7 @@ }, "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)." + "description": "The conversion tracking setting of the line item." }, "creativeIds": { "description": "The IDs of the creatives associated with the line item.", @@ -18363,7 +18675,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`. *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).", + "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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.", "format": "int64", "type": "string" }, @@ -19139,7 +19451,6 @@ "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", @@ -19149,8 +19460,8 @@ ], "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 Scope3 (previously known as Adloox). Billed by the partner.", + "The cost is charged for using Scope3 (previously known as 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.", @@ -19172,7 +19483,6 @@ "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.", @@ -19349,7 +19659,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`. *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).", + "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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.", "format": "int64", "type": "string" }, @@ -19873,7 +20183,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -19890,6 +20201,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -19907,7 +20219,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -19915,7 +20228,7 @@ "type": "object" }, "SdfDownloadTask": { - "description": "Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "description": "Type for the response returned by SdfDownloadTaskService.CreateSdfDownloadTask.", "id": "SdfDownloadTask", "properties": { "resourceName": { @@ -19926,7 +20239,7 @@ "type": "object" }, "SdfDownloadTaskMetadata": { - "description": "Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "description": "Type for the metadata returned by SdfDownloadTaskService.CreateSdfDownloadTask.", "id": "SdfDownloadTaskMetadata", "properties": { "createTime": { @@ -19956,7 +20269,8 @@ "SDF_VERSION_6", "SDF_VERSION_7", "SDF_VERSION_7_1", - "SDF_VERSION_8" + "SDF_VERSION_8", + "SDF_VERSION_8_1" ], "enumDeprecated": [ false, @@ -19973,6 +20287,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -19990,7 +20305,8 @@ "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." + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", + "SDF version 8.1." ], "type": "string" } @@ -20383,6 +20699,10 @@ "$ref": "ContentStreamTypeTargetingOptionDetails", "description": "Content stream type resource details." }, + "contentThemeDetails": { + "$ref": "ContentThemeTargetingOptionDetails", + "description": "Content theme details." + }, "deviceMakeModelDetails": { "$ref": "DeviceMakeModelTargetingOptionDetails", "description": "Device make and model resource details." @@ -20512,7 +20832,8 @@ "TARGETING_TYPE_CONTENT_GENRE", "TARGETING_TYPE_YOUTUBE_VIDEO", "TARGETING_TYPE_YOUTUBE_CHANNEL", - "TARGETING_TYPE_SESSION_POSITION" + "TARGETING_TYPE_SESSION_POSITION", + "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ "Default value when type is not specified or is unknown in this version.", @@ -20563,7 +20884,8 @@ "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." + "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.", + "Filter website content by content themes (for example, religion)." ], "readOnly": true, "type": "string" @@ -20727,7 +21049,7 @@ "properties": { "adloox": { "$ref": "Adloox", - "description": "Third party brand verifier -- Adloox." + "description": "Third party brand verifier -- Scope3 (previously known as Adloox)." }, "doubleVerify": { "$ref": "DoubleVerify", diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 8b855a10978..65f8cd4bf42 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -5113,7 +5113,7 @@ } } }, - "revision": "20250309", + "revision": "20250323", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -8621,7 +8621,7 @@ "type": "array" }, "fileStoreIsEmpty": { - "description": "The file store does not have any files.", + "description": "The file store does not have any files. If the profiling failed, this will be false.", "type": "boolean" }, "fileStoreLocation": { diff --git a/discovery/dns-v1.json b/discovery/dns-v1.json index f3cad301c99..b3b7a6d578d 100644 --- a/discovery/dns-v1.json +++ b/discovery/dns-v1.json @@ -1824,7 +1824,7 @@ } } }, - "revision": "20250227", + "revision": "20250411", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2428,6 +2428,10 @@ "ManagedZoneForwardingConfigNameServerTarget": { "id": "ManagedZoneForwardingConfigNameServerTarget", "properties": { + "domainName": { + "description": "Fully qualified domain name for the forwarding target.", + "type": "string" + }, "forwardingPath": { "description": "Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.", "enum": [ diff --git a/discovery/dns-v1beta2.json b/discovery/dns-v1beta2.json index 7667dfcbbf0..a920ceec399 100644 --- a/discovery/dns-v1beta2.json +++ b/discovery/dns-v1beta2.json @@ -1821,7 +1821,7 @@ } } }, - "revision": "20250227", + "revision": "20250411", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2425,6 +2425,10 @@ "ManagedZoneForwardingConfigNameServerTarget": { "id": "ManagedZoneForwardingConfigNameServerTarget", "properties": { + "domainName": { + "description": "Fully qualified domain name for the forwarding target.", + "type": "string" + }, "forwardingPath": { "description": "Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.", "enum": [ diff --git a/discovery/docs-v1.json b/discovery/docs-v1.json index a8c1dbf9285..108cfc8ba6d 100644 --- a/discovery/docs-v1.json +++ b/discovery/docs-v1.json @@ -26,7 +26,7 @@ "canonicalName": "Docs", "description": "Reads and writes Google Docs documents.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/docs/", + "documentationLink": "https://developers.google.com/workspace/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -221,7 +221,7 @@ } } }, - "revision": "20250218", + "revision": "20250325", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -3554,6 +3554,10 @@ "description": "Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive.", "type": "boolean" }, + "searchByRegex": { + "description": "Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching.", + "type": "boolean" + }, "text": { "description": "The text to search for in the document.", "type": "string" diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index 3a5fdd3e315..87f78e4f919 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -197,6 +197,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1042,7 +1048,7 @@ } } }, - "revision": "20250117", + "revision": "20250427", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -2226,6 +2232,10 @@ "format": "byte", "type": "string" }, + "docid": { + "description": "Optional. An internal identifier for document. Should be loggable (no PII).", + "type": "string" + }, "documentLayout": { "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayout", "description": "Parsed layout of the document." @@ -2419,6 +2429,10 @@ "description": "ID of the block.", "type": "string" }, + "boundingBox": { + "$ref": "GoogleCloudDocumentaiV1BoundingPoly", + "description": "Identifies the bounding box for the block." + }, "listBlock": { "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", "description": "Block consisting of list content/structure." @@ -2661,6 +2675,9 @@ "$ref": "GoogleTypeMoney", "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, + "signatureValue": { + "type": "boolean" + }, "text": { "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" @@ -3668,6 +3685,22 @@ "description": "User defined name for the property.", "type": "string" }, + "groundingConfig": { + "description": "Grounding config of the entity type.", + "enum": [ + "GROUNDING_CONFIG_UNSPECIFIED", + "STRICT", + "RELAXED", + "NO_GROUNDING" + ], + "enumDescriptions": [ + "Unspecified grounding config. It defaults to `STRICT` grounding.", + "Strict grounding.", + "Relaxed grounding.", + "Allow no grounding." + ], + "type": "string" + }, "name": { "description": "The name of the property. Follows the same guidelines as the EntityType name.", "type": "string" @@ -6196,18 +6229,18 @@ "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", + "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 or 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).", + "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 or 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). In 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.", + "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. 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": { @@ -6215,7 +6248,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -6223,7 +6256,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -6243,11 +6276,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 90a772c3d60..ec1ab5f3c8e 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1284,7 +1290,7 @@ } } }, - "revision": "20250210", + "revision": "20250427", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -3102,6 +3108,13 @@ "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.", "id": "GoogleCloudDocumentaiV1beta3Document", "properties": { + "blobAssets": { + "description": "Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentBlobAsset" + }, + "type": "array" + }, "chunkedDocument": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocument", "description": "Document chunked based on chunking config." @@ -3111,6 +3124,10 @@ "format": "byte", "type": "string" }, + "docid": { + "description": "Optional. An internal identifier for document. Should be loggable (no PII).", + "type": "string" + }, "documentLayout": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayout", "description": "Parsed layout of the document." @@ -3181,6 +3198,37 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentAnnotations": { + "description": "Represents the annotation of a block or a chunk.", + "id": "GoogleCloudDocumentaiV1beta3DocumentAnnotations", + "properties": { + "description": { + "description": "The description of the content with this annotation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentBlobAsset": { + "description": "Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.", + "id": "GoogleCloudDocumentaiV1beta3DocumentBlobAsset", + "properties": { + "assetId": { + "description": "Optional. The id of the blob asset.", + "type": "string" + }, + "content": { + "description": "Optional. The content of the blob asset, e.g. image bytes.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentChunkedDocument": { "description": "Represents the chunks that the document is divided into.", "id": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocument", @@ -3199,6 +3247,13 @@ "description": "Represents a chunk.", "id": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk", "properties": { + "chunkFields": { + "description": "Chunk fields inside this chunk.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField" + }, + "type": "array" + }, "chunkId": { "description": "ID of the chunk.", "type": "string" @@ -3235,6 +3290,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField": { + "description": "The chunk field in the chunk. A chunk field could be one of the various types (e.g. image, table) supported.", + "id": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField", + "properties": { + "imageChunkField": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField", + "description": "The image chunk field in the chunk." + }, + "tableChunkField": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField", + "description": "The table chunk field in the chunk." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter": { "description": "Represents the page footer associated with the chunk.", "id": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter", @@ -3282,6 +3352,40 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField": { + "description": "The image chunk field in the chunk.", + "id": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField", + "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentAnnotations", + "description": "Annotation of the image chunk field." + }, + "blobAssetId": { + "description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.", + "type": "string" + }, + "dataUri": { + "description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", + "type": "string" + }, + "gcsUri": { + "description": "Optional. Google Cloud Storage uri of the image.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField": { + "description": "The table chunk field in the chunk.", + "id": "GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField", + "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentAnnotations", + "description": "Annotation of the table chunk field." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentDocumentLayout": { "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", "id": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayout", @@ -3304,6 +3408,14 @@ "description": "ID of the block.", "type": "string" }, + "boundingBox": { + "$ref": "GoogleCloudDocumentaiV1beta3BoundingPoly", + "description": "Identifies the bounding box for the block." + }, + "imageBlock": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock", + "description": "Block consisting of image content." + }, "listBlock": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", "description": "Block consisting of list content/structure." @@ -3323,6 +3435,37 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock": { + "description": "Represents an image type block.", + "id": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock", + "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentAnnotations", + "description": "Annotation of the image block." + }, + "blobAssetId": { + "description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.", + "type": "string" + }, + "dataUri": { + "description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", + "type": "string" + }, + "gcsUri": { + "description": "Optional. Google Cloud Storage uri of the image.", + "type": "string" + }, + "imageText": { + "description": "Text extracted from the image using OCR or alt text describing the image.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { "description": "Represents a list type block.", "id": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", @@ -3376,6 +3519,10 @@ "description": "Represents a table type block.", "id": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentAnnotations", + "description": "Annotation of the table block." + }, "bodyRows": { "description": "Body rows containing main table content.", "items": { @@ -3546,6 +3693,9 @@ "$ref": "GoogleTypeMoney", "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, + "signatureValue": { + "type": "boolean" + }, "text": { "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" @@ -4663,6 +4813,22 @@ "description": "User defined name for the property.", "type": "string" }, + "groundingConfig": { + "description": "Grounding config of the entity type.", + "enum": [ + "GROUNDING_CONFIG_UNSPECIFIED", + "STRICT", + "RELAXED", + "NO_GROUNDING" + ], + "enumDescriptions": [ + "Unspecified grounding config. It defaults to `STRICT` grounding.", + "Strict grounding.", + "Relaxed grounding.", + "Allow no grounding." + ], + "type": "string" + }, "name": { "description": "The name of the property. Follows the same guidelines as the EntityType name.", "type": "string" @@ -5697,6 +5863,22 @@ "$ref": "GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig", "description": "Optional. Config for chunking in layout parser processor." }, + "enableImageAnnotation": { + "description": "Optional. Whether to include image annotations in layout parser response.", + "type": "boolean" + }, + "enableImageExtraction": { + "description": "Optional. Whether to extract images in layout parser response.", + "type": "boolean" + }, + "enableLlmLayoutParsing": { + "description": "Optional. Whether to refine PDF layout using LLM.", + "type": "boolean" + }, + "enableTableAnnotation": { + "description": "Optional. Whether to include table annotations in layout parser response.", + "type": "boolean" + }, "returnBoundingBoxes": { "description": "Optional. Whether to include bounding boxes in layout parser processor response.", "type": "boolean" @@ -6843,18 +7025,18 @@ "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", + "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 or 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).", + "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 or 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). In 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.", + "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. 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": { @@ -6862,7 +7044,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -6870,7 +7052,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -6890,11 +7072,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index e61ede4c1bf..364d3ce0535 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -40,7 +40,7 @@ "batchPath": "batch/drive/v2", "description": "The Google Drive API allows clients to access resources from Google Drive.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/drive/", + "documentationLink": "https://developers.google.com/workspace/drive/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -1134,7 +1134,7 @@ ] }, "list": { - "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.", + "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/workspace/drive/api/guides/search-shareddrives) guide.", "flatPath": "drives", "httpMethod": "GET", "id": "drive.drives.list", @@ -1485,7 +1485,7 @@ ] }, "get": { - "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).", + "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).", "flatPath": "files/{fileId}", "httpMethod": "GET", "id": "drive.files.get", @@ -1574,7 +1574,7 @@ "useMediaDownloadService": true }, "insert": { - "description": " Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"title\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", + "description": " Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"title\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", "flatPath": "files", "httpMethod": "POST", "id": "drive.files.insert", @@ -1696,7 +1696,7 @@ "supportsMediaUpload": true }, "list": { - "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", @@ -2202,7 +2202,7 @@ ] }, "update": { - "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).", + "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", "flatPath": "files/{fileId}", "httpMethod": "PUT", "id": "drive.files.update", @@ -3887,7 +3887,7 @@ } } }, - "revision": "20250216", + "revision": "20250427", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4559,7 +4559,7 @@ "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments).", + "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments).", "type": "string" }, "author": { @@ -6743,33 +6743,40 @@ "properties": { "displayName": { "description": "Output only. A plain text displayable name for this user.", + "readOnly": true, "type": "string" }, "emailAddress": { - "description": "Output only. The email address of the user.", + "description": "Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", + "readOnly": true, "type": "string" }, "isAuthenticatedUser": { "description": "Output only. Whether this user is the same as the authenticated user for whom the request was made.", + "readOnly": true, "type": "boolean" }, "kind": { "default": "drive#user", - "description": "Output only. This is always `drive#user`.", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.", + "readOnly": true, "type": "string" }, "permissionId": { - "description": "Output only. The user's ID as visible in the permissions collection.", + "description": "Output only. The user's ID as visible in Permission resources.", + "readOnly": true, "type": "string" }, "picture": { "description": "Output only. The user's profile picture.", "properties": { "url": { - "description": "Output Only. A URL that points to a profile picture of this user.", + "description": "Output only. A URL that points to a profile picture of this user.", + "readOnly": true, "type": "string" } }, + "readOnly": true, "type": "object" } }, diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index b35abfb3be9..a00d4ee8cad 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -40,7 +40,7 @@ "batchPath": "batch/drive/v3", "description": "The Google Drive API allows clients to access resources from Google Drive.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/drive/", + "documentationLink": "https://developers.google.com/workspace/drive/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -133,7 +133,7 @@ "about": { "methods": { "get": { - "description": "Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/drive/api/guides/user-info). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter).", + "description": "Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "flatPath": "about", "httpMethod": "GET", "id": "drive.about.get", @@ -268,7 +268,7 @@ "apps": { "methods": { "get": { - "description": "Gets a specific app. For more information, see [Return user info](https://developers.google.com/drive/api/guides/user-info).", + "description": "Gets a specific app. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info).", "flatPath": "apps/{appId}", "httpMethod": "GET", "id": "drive.apps.get", @@ -298,7 +298,7 @@ ] }, "list": { - "description": "Lists a user's installed apps. For more information, see [Return user info](https://developers.google.com/drive/api/guides/user-info).", + "description": "Lists a user's installed apps. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info).", "flatPath": "apps", "httpMethod": "GET", "id": "drive.apps.list", @@ -335,7 +335,7 @@ "changes": { "methods": { "getStartPageToken": { - "description": "Gets the starting pageToken for listing future changes. For more information, see [Retrieve changes](https://developers.google.com/drive/api/guides/manage-changes).", + "description": "Gets the starting pageToken for listing future changes. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).", "flatPath": "changes/startPageToken", "httpMethod": "GET", "id": "drive.changes.getStartPageToken", @@ -382,7 +382,7 @@ ] }, "list": { - "description": "Lists the changes for a user or shared drive. For more information, see [Retrieve changes](https://developers.google.com/drive/api/guides/manage-changes).", + "description": "Lists the changes for a user or shared drive. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).", "flatPath": "changes", "httpMethod": "GET", "id": "drive.changes.list", @@ -494,7 +494,7 @@ "supportsSubscription": true }, "watch": { - "description": "Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/drive/api/guides/push).", + "description": "Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "flatPath": "changes/watch", "httpMethod": "POST", "id": "drive.changes.watch", @@ -614,7 +614,7 @@ "channels": { "methods": { "stop": { - "description": "Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/drive/api/guides/push).", + "description": "Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).", "flatPath": "channels/stop", "httpMethod": "POST", "id": "drive.channels.stop", @@ -641,7 +641,7 @@ "comments": { "methods": { "create": { - "description": "Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter).", + "description": "Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "flatPath": "files/{fileId}/comments", "httpMethod": "POST", "id": "drive.comments.create", @@ -669,7 +669,7 @@ ] }, "delete": { - "description": "Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter).", + "description": "Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "DELETE", "id": "drive.comments.delete", @@ -698,7 +698,7 @@ ] }, "get": { - "description": "Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter).", + "description": "Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "GET", "id": "drive.comments.get", @@ -738,7 +738,7 @@ ] }, "list": { - "description": "Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter).", + "description": "Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "flatPath": "files/{fileId}/comments", "httpMethod": "GET", "id": "drive.comments.list", @@ -790,7 +790,7 @@ ] }, "update": { - "description": "Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter).", + "description": "Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "PATCH", "id": "drive.comments.update", @@ -944,7 +944,7 @@ ] }, "list": { - "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.", + "description": " Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/workspace/drive/api/guides/search-shareddrives) guide.", "flatPath": "drives", "httpMethod": "GET", "id": "drive.drives.list", @@ -1123,7 +1123,7 @@ ] }, "create": { - "description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", + "description": " Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.", "flatPath": "files", "httpMethod": "POST", "id": "drive.files.create", @@ -1389,7 +1389,7 @@ ] }, "get": { - "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).", + "description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads).", "flatPath": "files/{fileId}", "httpMethod": "GET", "id": "drive.files.get", @@ -1452,7 +1452,7 @@ "useMediaDownloadService": true }, "list": { - "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", + "description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.", "flatPath": "files", "httpMethod": "GET", "id": "drive.files.list", @@ -1643,7 +1643,7 @@ ] }, "update": { - "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).", + "description": " Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).", "flatPath": "files/{fileId}", "httpMethod": "PATCH", "id": "drive.files.update", @@ -2800,7 +2800,7 @@ } } }, - "revision": "20250220", + "revision": "20250427", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3306,7 +3306,7 @@ "id": "Comment", "properties": { "anchor": { - "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/drive/api/v3/manage-comments).", + "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).", "type": "string" }, "author": { @@ -4677,7 +4677,7 @@ "type": "object" }, "Permission": { - "description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.", + "description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.", "id": "Permission", "properties": { "allowFileDiscovery": { @@ -5291,27 +5291,33 @@ "properties": { "displayName": { "description": "Output only. A plain text displayable name for this user.", + "readOnly": true, "type": "string" }, "emailAddress": { "description": "Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", + "readOnly": true, "type": "string" }, "kind": { "default": "drive#user", - "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#user\"`.", + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.", + "readOnly": true, "type": "string" }, "me": { "description": "Output only. Whether this user is the requesting user.", + "readOnly": true, "type": "boolean" }, "permissionId": { "description": "Output only. The user's ID as visible in Permission resources.", + "readOnly": true, "type": "string" }, "photoLink": { "description": "Output only. A link to the user's profile photo, if available.", + "readOnly": true, "type": "string" } }, diff --git a/discovery/driveactivity-v2.json b/discovery/driveactivity-v2.json index 540bc2bf5a4..ffcc4fc17e9 100644 --- a/discovery/driveactivity-v2.json +++ b/discovery/driveactivity-v2.json @@ -17,7 +17,7 @@ "canonicalName": "Drive Activity", "description": "Provides a historical view of activity in Google Drive.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/drive/activity/", + "documentationLink": "https://developers.google.com/workspace/drive/activity/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -132,7 +132,7 @@ } } }, - "revision": "20230704", + "revision": "20250329", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { @@ -634,7 +634,7 @@ "description": "This field is deprecated; please use the `driveFolder` field instead." }, "mimeType": { - "description": "The MIME type of the Drive item. See https://developers.google.com/drive/v3/web/mime-types.", + "description": "The MIME type of the Drive item. See https://developers.google.com/workspace/drive/v3/web/mime-types.", "type": "string" }, "name": { @@ -780,11 +780,11 @@ "id": "FileComment", "properties": { "legacyCommentId": { - "description": "The comment in the discussion thread. This identifier is an opaque string compatible with the Drive API; see https://developers.google.com/drive/v3/reference/comments/get", + "description": "The comment in the discussion thread. This identifier is an opaque string compatible with the Drive API; see https://developers.google.com/workspace/drive/v3/reference/comments/get", "type": "string" }, "legacyDiscussionId": { - "description": "The discussion thread to which the comment was added. This identifier is an opaque string compatible with the Drive API and references the first comment in a discussion; see https://developers.google.com/drive/v3/reference/comments/get", + "description": "The discussion thread to which the comment was added. This identifier is an opaque string compatible with the Drive API and references the first comment in a discussion; see https://developers.google.com/workspace/drive/v3/reference/comments/get", "type": "string" }, "linkToDiscussion": { @@ -959,7 +959,7 @@ "description": "The group to whom this permission applies." }, "role": { - "description": "Indicates the [Google Drive permissions role](https://developers.google.com/drive/web/manage-sharing#roles). The role determines a user's ability to read, write, and comment on items.", + "description": "Indicates the [Google Drive permissions role](https://developers.google.com/workspace/drive/web/manage-sharing#roles). The role determines a user's ability to read, write, and comment on items.", "enum": [ "ROLE_UNSPECIFIED", "OWNER", @@ -1273,7 +1273,7 @@ "type": "object" }, "Target": { - "description": "Information about the target of activity. For more information on how activity history is shared with users, see [Activity history visibility](https://developers.google.com/drive/activity/v2#activityhistory).", + "description": "Information about the target of activity. For more information on how activity history is shared with users, see [Activity history visibility](https://developers.google.com/workspace/drive/activity/v2#activityhistory).", "id": "Target", "properties": { "drive": { diff --git a/discovery/drivelabels-v2.json b/discovery/drivelabels-v2.json index 8a3545bfa09..fc6ed80a6f4 100644 --- a/discovery/drivelabels-v2.json +++ b/discovery/drivelabels-v2.json @@ -23,7 +23,7 @@ "canonicalName": "Drive Labels", "description": "An API for managing Drive Labels", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/drive/labels", + "documentationLink": "https://developers.google.com/workspace/drive/labels", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1032,7 +1032,7 @@ } } }, - "revision": "20231218", + "revision": "20250331", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2BadgeColors": { diff --git a/discovery/drivelabels-v2beta.json b/discovery/drivelabels-v2beta.json index 749d0eb72a9..851025911c4 100644 --- a/discovery/drivelabels-v2beta.json +++ b/discovery/drivelabels-v2beta.json @@ -23,7 +23,7 @@ "canonicalName": "Drive Labels", "description": "An API for managing Drive Labels", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/drive/labels", + "documentationLink": "https://developers.google.com/workspace/drive/labels", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1032,7 +1032,7 @@ } } }, - "revision": "20231218", + "revision": "20250331", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2betaBadgeColors": { diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index 0f65c762920..d593404a8ea 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2460,7 +2466,7 @@ } } }, - "revision": "20250307", + "revision": "20250411", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { @@ -2749,7 +2755,7 @@ "type": "object" }, "messageBus": { - "description": "Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.", + "description": "Required. Immutable. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.", "type": "string" }, "name": { diff --git a/discovery/file-v1.json b/discovery/file-v1.json index 34f976f3a66..b8d22204864 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -143,15 +143,16 @@ "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).", + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", "location": "query", + "repeated": true, "type": "string" }, - "includeUnrevealedLocations": { - "description": "If true, the returned list will include locations which are not yet revealed.", + "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": "boolean" + "type": "string" }, "name": { "description": "The resource that owns the locations collection, if applicable.", @@ -907,7 +908,7 @@ } } }, - "revision": "20250205", + "revision": "20250421", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1165,6 +1166,10 @@ "description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).", "type": "string" }, + "consumerProjectNumber": { + "description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "format": "google-datetime", diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index f7da26ff4b4..b42dcc0ba91 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -143,15 +143,16 @@ "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).", + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", "location": "query", + "repeated": true, "type": "string" }, - "includeUnrevealedLocations": { - "description": "If true, the returned list will include locations which are not yet revealed.", + "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": "boolean" + "type": "string" }, "name": { "description": "The resource that owns the locations collection, if applicable.", @@ -1074,7 +1075,7 @@ } } }, - "revision": "20250205", + "revision": "20250421", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1280,9 +1281,13 @@ "type": "object" }, "DirectoryServicesConfig": { - "description": "Directory Services configuration for Kerberos-based authentication.", + "description": "Directory Services configuration.", "id": "DirectoryServicesConfig", "properties": { + "ldap": { + "$ref": "LdapConfig", + "description": "Configuration for LDAP servers." + }, "managedActiveDirectory": { "$ref": "ManagedActiveDirectoryConfig", "description": "Configuration for Managed Service for Microsoft Active Directory." @@ -1343,6 +1348,10 @@ "description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).", "type": "string" }, + "consumerProjectNumber": { + "description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "format": "google-datetime", @@ -1662,7 +1671,7 @@ }, "directoryServices": { "$ref": "DirectoryServicesConfig", - "description": "Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is \"NFS_V4_1\"." + "description": "Optional. Directory Services configuration. Should only be set if protocol is \"NFS_V4_1\"." }, "etag": { "description": "Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.", @@ -1840,6 +1849,32 @@ }, "type": "object" }, + "LdapConfig": { + "description": "LdapConfig contains all the parameters for connecting to LDAP servers.", + "id": "LdapConfig", + "properties": { + "domain": { + "description": "Required. The LDAP domain name in the format of `my-domain.com`.", + "type": "string" + }, + "groupsOu": { + "description": "Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.", + "type": "string" + }, + "servers": { + "description": "Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "usersOu": { + "description": "Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.", + "type": "string" + } + }, + "type": "object" + }, "ListBackupsResponse": { "description": "ListBackupsResponse is the result of ListBackupsRequest.", "id": "ListBackupsResponse", @@ -2099,12 +2134,14 @@ "enum": [ "CONNECT_MODE_UNSPECIFIED", "DIRECT_PEERING", - "PRIVATE_SERVICE_ACCESS" + "PRIVATE_SERVICE_ACCESS", + "PRIVATE_SERVICE_CONNECT" ], "enumDescriptions": [ "ConnectMode not set.", "Connect via direct peering to the Filestore service.", - "Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore." + "Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore.", + "Connect to your Filestore instance using Private Service Connect. A connection policy must exist in the region for the VPC network and the google-cloud-filestore service class." ], "type": "string" }, @@ -2135,6 +2172,10 @@ "description": "The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.", "type": "string" }, + "pscConfig": { + "$ref": "PscConfig", + "description": "Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT." + }, "reservedIpRange": { "description": "Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.", "type": "string" @@ -2177,6 +2218,10 @@ }, "type": "array" }, + "network": { + "description": "Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.", + "type": "string" + }, "securityFlavors": { "description": "The security flavors allowed for mount operations. The default is AUTH_SYS.", "items": { @@ -2357,6 +2402,17 @@ }, "type": "object" }, + "PscConfig": { + "description": "Private Service Connect configuration.", + "id": "PscConfig", + "properties": { + "endpointProject": { + "description": "Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.", + "type": "string" + } + }, + "type": "object" + }, "ReplicaConfig": { "description": "Replica configuration for the instance.", "id": "ReplicaConfig", diff --git a/discovery/firebase-v1beta1.json b/discovery/firebase-v1beta1.json index 8a5c93705cc..a13bc416ab2 100644 --- a/discovery/firebase-v1beta1.json +++ b/discovery/firebase-v1beta1.json @@ -1324,7 +1324,7 @@ } } }, - "revision": "20250314", + "revision": "20250331", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { @@ -1919,6 +1919,8 @@ "type": "object" }, "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", "id": "MessageSet", "properties": {}, "type": "object" diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index bc6b1c39319..462d2e64159 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -169,30 +169,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "provisionApp": { - "description": "Provision app distribution for an existing Firebase app, enabling it to subsequently be used by appdistro.", - "flatPath": "v1alpha/apps/{mobilesdkAppId}", - "httpMethod": "POST", - "id": "firebaseappdistribution.apps.provisionApp", - "parameterOrder": [ - "mobilesdkAppId" - ], - "parameters": { - "mobilesdkAppId": { - "description": "Unique id for a Firebase app of the format: {version}:{project_number}:{platform}:{hash(bundle_id)} Example: 1:581234567376:android:aa0a3c7b135e90289", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/apps/{mobilesdkAppId}", - "response": { - "$ref": "GoogleFirebaseAppdistroV1alphaProvisionAppResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } }, "resources": { @@ -436,7 +412,7 @@ ] }, "updateTestConfig": { - "description": "Updates a release.", + "description": "Updates automated test configuration.", "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testConfig", "httpMethod": "PATCH", "id": "firebaseappdistribution.projects.apps.updateTestConfig", @@ -831,7 +807,7 @@ } } }, - "revision": "20250314", + "revision": "20250416", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -959,7 +935,6 @@ "type": "object" }, "GoogleFirebaseAppdistroV1alphaAiInstructions": { - "description": "Instructions for AI driven test", "id": "GoogleFirebaseAppdistroV1alphaAiInstructions", "properties": { "steps": { @@ -1669,12 +1644,6 @@ }, "type": "object" }, - "GoogleFirebaseAppdistroV1alphaProvisionAppResponse": { - "description": "The response message for `ProvisionApp`.", - "id": "GoogleFirebaseAppdistroV1alphaProvisionAppResponse", - "properties": {}, - "type": "object" - }, "GoogleFirebaseAppdistroV1alphaRelease": { "description": "Proto defining a release object", "id": "GoogleFirebaseAppdistroV1alphaRelease", diff --git a/discovery/firebasedataconnect-v1.json b/discovery/firebasedataconnect-v1.json new file mode 100644 index 00000000000..44d7722909a --- /dev/null +++ b/discovery/firebasedataconnect-v1.json @@ -0,0 +1,1849 @@ +{ + "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://firebasedataconnect.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Firebase Data Connect", + "description": "Firebase Data Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered by Cloud SQL. The REST API lets developers manage the connections to their database, change the schema of their database, and query the database.", + "discoveryVersion": "v1", + "documentationLink": "https://firebase.google.com/docs/data-connect", + "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": "firebasedataconnect:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://firebasedataconnect.mtls.googleapis.com/", + "name": "firebasedataconnect", + "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": "firebasedataconnect.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": "firebasedataconnect.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, + "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": { + "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": "firebasedataconnect.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": "firebasedataconnect.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": "firebasedataconnect.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": "firebasedataconnect.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" + ] + } + } + }, + "services": { + "methods": { + "create": { + "description": "Creates a new Service in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Value of parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "serviceId": { + "description": "Required. The ID to use for the service, which will become the final component of the service's resource name.", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Service, but do not actually create it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/services", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", + "httpMethod": "DELETE", + "id": "firebasedataconnect.projects.locations.services.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the Service is not found, the request will succeed but no action will be taken on the server.", + "location": "query", + "type": "boolean" + }, + "etag": { + "description": "Optional. The etag of the Service. If this is provided, it must match the server's etag.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any child resources (i.e. Schema, SchemaRevisions, Connectors, and ConnectorRevisions) will also be deleted. Otherwise, the request will only work if the Service has no child resources.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the service to delete, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Service, but do not actually delete it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeGraphql": { + "description": "Execute any GraphQL query and mutation against the Firebase Data Connect's generated GraphQL schema. Grants full read and write access to the connected data sources. Note: Use introspection query to explore the generated GraphQL schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:executeGraphql", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.executeGraphql", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeGraphql", + "request": { + "$ref": "GraphqlRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeGraphqlRead": { + "description": "Execute any GraphQL query against the Firebase Data Connect's generated GraphQL schema. Grants full read to the connected data sources. `ExecuteGraphqlRead` is identical to `ExecuteGraphql` except it only accepts read-only query.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:executeGraphqlRead", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.executeGraphqlRead", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeGraphqlRead", + "request": { + "$ref": "GraphqlRequest" + }, + "response": { + "$ref": "GraphqlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", + "httpMethod": "GET", + "id": "firebasedataconnect.projects.locations.services.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the service to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Service" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Services in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", + "httpMethod": "GET", + "id": "firebasedataconnect.projects.locations.services.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 page token, received from a previous `ListServices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListServices` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value of parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/services", + "response": { + "$ref": "ListServicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", + "httpMethod": "PATCH", + "id": "firebasedataconnect.projects.locations.services.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the Service is not found, a new Service will be created. In this case, `update_mask` is ignored.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The relative resource name of the Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase Data Connect and does not correspond to any of the instance IDs of the underlying data source connections.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Service, but do not actually update it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "connectors": { + "methods": { + "create": { + "description": "Creates a new Connector in a given project and location. The operations are validated against and must be compatible with the active schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.connectors.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "connectorId": { + "description": "Required. The ID to use for the connector, which will become the final component of the connector's resource name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Connector, but do not actually create it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/connectors", + "request": { + "$ref": "Connector" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}", + "httpMethod": "DELETE", + "id": "firebasedataconnect.projects.locations.services.connectors.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the Connector is not found, the request will succeed but no action will be taken on the server.", + "location": "query", + "type": "boolean" + }, + "etag": { + "description": "Optional. The etag of the Connector. If this is provided, it must match the server's etag.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any child resources (i.e. ConnectorRevisions) will also be deleted. Otherwise, the request will only work if the Connector has no child resources.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the connector to delete, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Connector, but do not actually delete it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeMutation": { + "description": "Execute a predefined mutation in a Connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:executeMutation", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.connectors.executeMutation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the connector to find the predefined mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeMutation", + "request": { + "$ref": "ExecuteMutationRequest" + }, + "response": { + "$ref": "ExecuteMutationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeQuery": { + "description": "Execute a predefined query in a Connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:executeQuery", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.connectors.executeQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the connector to find the predefined query, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeQuery", + "request": { + "$ref": "ExecuteQueryRequest" + }, + "response": { + "$ref": "ExecuteQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}", + "httpMethod": "GET", + "id": "firebasedataconnect.projects.locations.services.connectors.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the connector to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Connector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Connectors in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors", + "httpMethod": "GET", + "id": "firebasedataconnect.projects.locations.services.connectors.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 page token, received from a previous `ListConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectors` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value of parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/connectors", + "response": { + "$ref": "ListConnectorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Connector, and creates a new ConnectorRevision with the updated Connector. The operations are validated against and must be compatible with the live schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}", + "httpMethod": "PATCH", + "id": "firebasedataconnect.projects.locations.services.connectors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the Connector is not found, a new Connector will be created. In this case, `update_mask` is ignored.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Connector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Connector, but do not actually update it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Connector" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "schemas": { + "methods": { + "create": { + "description": "Creates a new Schema in a given project and location. Only creation of `schemas/main` is supported and calling create with any other schema ID will result in an error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.schemas.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "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" + }, + "schemaId": { + "description": "Required. The ID to use for the schema, which will become the final component of the schema's resource name. Currently, only `main` is supported and any other schema ID will result in an error.", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Schema, but do not actually update it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/schemas", + "request": { + "$ref": "Schema" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Schema. Because the schema and connectors must be compatible at all times, if this is called while any connectors are active, this will result in an error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}", + "httpMethod": "DELETE", + "id": "firebasedataconnect.projects.locations.services.schemas.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the Schema is not found, the request will succeed but no action will be taken on the server.", + "location": "query", + "type": "boolean" + }, + "etag": { + "description": "Optional. The etag of the Schema. If this is provided, it must match the server's etag.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any child resources (i.e. SchemaRevisions) will also be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the schema to delete, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Schema, but do not actually delete it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}", + "httpMethod": "GET", + "id": "firebasedataconnect.projects.locations.services.schemas.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schema to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ```", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Schema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas", + "httpMethod": "GET", + "id": "firebasedataconnect.projects.locations.services.schemas.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 page token, received from a previous `ListSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSchemas` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value of parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemas", + "response": { + "$ref": "ListSchemasResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}", + "httpMethod": "PATCH", + "id": "firebasedataconnect.projects.locations.services.schemas.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the Schema is not found, a new Schema will be created. In this case, `update_mask` is ignored.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is \"main\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Schema resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validate the request and preview the Schema, but do not actually update it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Schema" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20250323", + "rootUrl": "https://firebasedataconnect.googleapis.com/", + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CloudSqlInstance": { + "description": "Settings for CloudSQL instance configuration.", + "id": "CloudSqlInstance", + "properties": { + "instance": { + "description": "Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ```", + "type": "string" + } + }, + "type": "object" + }, + "Connector": { + "description": "Connector consists of a set of operations, i.e. queries and mutations.", + "id": "Connector", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Stores small amounts of arbitrary data.", + "type": "object" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Mutable human-readable name. 63 character limit.", + "type": "string" + }, + "etag": { + "description": "Output only. 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. [AIP-154](https://google.aip.dev/154)", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that if true, indicates that the system is working to compile and deploy the connector.", + "readOnly": true, + "type": "boolean" + }, + "source": { + "$ref": "Source", + "description": "Required. The source files that comprise the connector." + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Datasource": { + "description": "A data source that backs Firebase Data Connect services.", + "id": "Datasource", + "properties": { + "postgresql": { + "$ref": "PostgreSql", + "description": "PostgreSQL configurations." + } + }, + "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" + }, + "ExecuteMutationRequest": { + "description": "The ExecuteMutation request to Firebase Data Connect.", + "id": "ExecuteMutationRequest", + "properties": { + "operationName": { + "description": "Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name.", + "type": "string" + }, + "variables": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Values for GraphQL variables provided in this request.", + "type": "object" + } + }, + "type": "object" + }, + "ExecuteMutationResponse": { + "description": "The ExecuteMutation response from Firebase Data Connect.", + "id": "ExecuteMutationResponse", + "properties": { + "data": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The result of executing the requested operation.", + "type": "object" + }, + "errors": { + "description": "Errors of this response.", + "items": { + "$ref": "GraphqlError" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExecuteQueryRequest": { + "description": "The ExecuteQuery request to Firebase Data Connect.", + "id": "ExecuteQueryRequest", + "properties": { + "operationName": { + "description": "Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name.", + "type": "string" + }, + "variables": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Values for GraphQL variables provided in this request.", + "type": "object" + } + }, + "type": "object" + }, + "ExecuteQueryResponse": { + "description": "The ExecuteQuery response from Firebase Data Connect.", + "id": "ExecuteQueryResponse", + "properties": { + "data": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The result of executing the requested operation.", + "type": "object" + }, + "errors": { + "description": "Errors of this response.", + "items": { + "$ref": "GraphqlError" + }, + "type": "array" + } + }, + "type": "object" + }, + "File": { + "description": "Individual files.", + "id": "File", + "properties": { + "content": { + "description": "Required. The file's textual content.", + "type": "string" + }, + "path": { + "description": "Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql).", + "type": "string" + } + }, + "type": "object" + }, + "GraphqlError": { + "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.", + "id": "GraphqlError", + "properties": { + "extensions": { + "$ref": "GraphqlErrorExtensions", + "description": "Additional error information." + }, + "locations": { + "description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.", + "items": { + "$ref": "SourceLocation" + }, + "type": "array" + }, + "message": { + "description": "The detailed error message. The message should help developer understand the underlying problem without leaking internal data.", + "type": "string" + }, + "path": { + "description": "The result field which could not be populated due to error. Clients can use path to identify whether a null result is intentional or caused by a runtime error. It should be a list of string or index from the root of GraphQL query document.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "GraphqlErrorExtensions": { + "description": "GraphqlErrorExtensions contains additional information of `GraphqlError`.", + "id": "GraphqlErrorExtensions", + "properties": { + "file": { + "description": "The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.", + "type": "string" + } + }, + "type": "object" + }, + "GraphqlRequest": { + "description": "The GraphQL request to Firebase Data Connect. It strives to match the GraphQL over HTTP spec. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#post", + "id": "GraphqlRequest", + "properties": { + "extensions": { + "$ref": "GraphqlRequestExtensions", + "description": "Optional. Additional GraphQL request information." + }, + "operationName": { + "description": "Optional. The name of the GraphQL operation name. Required only if `query` contains multiple operations. See https://graphql.org/learn/queries/#operation-name.", + "type": "string" + }, + "query": { + "description": "Required. The GraphQL query document source.", + "type": "string" + }, + "variables": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Values for GraphQL variables provided in this request.", + "type": "object" + } + }, + "type": "object" + }, + "GraphqlRequestExtensions": { + "description": "GraphqlRequestExtensions contains additional information of `GraphqlRequest`.", + "id": "GraphqlRequestExtensions", + "properties": { + "impersonate": { + "$ref": "Impersonation", + "description": "Optional. If set, impersonate a request with given Firebase Auth context and evaluate the auth policies on the operation. If omitted, bypass any defined auth policies." + } + }, + "type": "object" + }, + "GraphqlResponse": { + "description": "The GraphQL response from Firebase Data Connect. It strives to match the GraphQL over HTTP spec. Note: Firebase Data Connect always responds with `Content-Type: application/json`. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#body", + "id": "GraphqlResponse", + "properties": { + "data": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The result of the execution of the requested operation. If an error was raised before execution begins, the data entry should not be present in the result. (a request error: https://spec.graphql.org/draft/#sec-Errors.Request-Errors) If an error was raised during the execution that prevented a valid response, the data entry in the response should be null. (a field error: https://spec.graphql.org/draft/#sec-Errors.Error-Result-Format)", + "type": "object" + }, + "errors": { + "description": "Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors.", + "items": { + "$ref": "GraphqlError" + }, + "type": "array" + } + }, + "type": "object" + }, + "Impersonation": { + "description": "Impersonation configures the Firebase Auth context to impersonate.", + "id": "Impersonation", + "properties": { + "authClaims": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Evaluate the auth policy with a customized JWT auth token. Should follow the Firebase Auth token format. https://firebase.google.com/docs/rules/rules-and-auth For example: a verified user may have auth_claims of {\"sub\": , \"email_verified\": true}", + "type": "object" + }, + "unauthenticated": { + "description": "Evaluate the auth policy as an unauthenticated request. Can only be set to true.", + "type": "boolean" + } + }, + "type": "object" + }, + "ListConnectorsResponse": { + "description": "Message for response to listing Connectors. By default, `connectors.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`.", + "id": "ListConnectorsResponse", + "properties": { + "connectors": { + "description": "The list of Connectors.", + "items": { + "$ref": "Connector" + }, + "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": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSchemasResponse": { + "description": "Message for response to listing Schemas. By default, `schemas.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`.", + "id": "ListSchemasResponse", + "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" + }, + "schemas": { + "description": "The list of Schemas.", + "items": { + "$ref": "Schema" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListServicesResponse": { + "description": "Message for response to listing Services.", + "id": "ListServicesResponse", + "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" + }, + "services": { + "description": "The list of Services.", + "items": { + "$ref": "Service" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, 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. Note: This message is auto-generated by CCFE. CCFE's storage, called Resource Metadata Store (RMS), holds metadata about long-running operations (i.e. OperationMetadata) and resources (i.e. ResourceMetadata). OperationMetadata documents the status of the operation. See [CCFE documentation for sidechannel data](https://g3doc.corp.google.com/cloud/control2/g3doc/dev/codelab_extras/sidechannel.md?cl=head#sidechannel-data) and yaqs/4289526912465764352.", + "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" + }, + "PostgreSql": { + "description": "Settings for PostgreSQL data source.", + "id": "PostgreSql", + "properties": { + "cloudSql": { + "$ref": "CloudSqlInstance", + "description": "Cloud SQL configurations." + }, + "database": { + "description": "Required. Name of the PostgreSQL database.", + "type": "string" + }, + "schemaMigration": { + "description": "Optional. Configure how to perform Postgresql schema migration.", + "enum": [ + "SQL_SCHEMA_MIGRATION_UNSPECIFIED", + "MIGRATE_COMPATIBLE" + ], + "enumDescriptions": [ + "Unspecified SQL schema migration.", + "Connect to the SQL database and identify any missing SQL resources used in the given Firebase Data Connect Schema. Automatically create necessary SQL resources (SQL table, column, etc) before deploying the schema. During migration steps, the SQL Schema must comply with the previous before_deploy setting in case the migration is interrupted. Therefore, the previous before_deploy setting must not be `schema_validation=STRICT`." + ], + "type": "string" + }, + "schemaValidation": { + "description": "Optional. Configure how much Postgresql schema validation to perform.", + "enum": [ + "SQL_SCHEMA_VALIDATION_UNSPECIFIED", + "NONE", + "STRICT", + "COMPATIBLE" + ], + "enumDescriptions": [ + "Unspecified SQL schema validation. Default to STRICT.", + "Skip no SQL schema validation. Use it with extreme caution. CreateSchema or UpdateSchema will succeed even if SQL database is unavailable or SQL schema is incompatible. Generated SQL may fail at execution time.", + "Connect to the SQL database and validate that the SQL DDL matches the schema exactly. Surface any discrepancies as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail.", + "Connect to the SQL database and validate that the SQL DDL has all the SQL resources used in the given Firebase Data Connect Schema. Surface any missing resources as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail. Succeed even if there are unknown tables and columns." + ], + "type": "string" + }, + "unlinked": { + "description": "No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured.", + "type": "boolean" + } + }, + "type": "object" + }, + "Schema": { + "description": "The application schema of a Firebase Data Connect service.", + "id": "Schema", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Stores small amounts of arbitrary data.", + "type": "object" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "datasources": { + "description": "Required. The data sources linked in the schema.", + "items": { + "$ref": "Datasource" + }, + "type": "array" + }, + "displayName": { + "description": "Optional. Mutable human-readable name. 63 character limit.", + "type": "string" + }, + "etag": { + "description": "Output only. 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. [AIP-154](https://google.aip.dev/154)", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is \"main\".", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that if true, indicates that the system is working to compile and deploy the schema.", + "readOnly": true, + "type": "boolean" + }, + "source": { + "$ref": "Source", + "description": "Required. The source files that comprise the application schema." + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Service": { + "description": "A Firebase Data Connect service.", + "id": "Service", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Stores small amounts of arbitrary data.", + "type": "object" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Mutable human-readable name. 63 character limit.", + "type": "string" + }, + "etag": { + "description": "Output only. 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. [AIP-154](https://google.aip.dev/154)", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Identifier. The relative resource name of the Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase Data Connect and does not correspond to any of the instance IDs of the underlying data source connections.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that if true, indicates that the system is working update the service.", + "readOnly": true, + "type": "boolean" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Source": { + "description": "Used to represent a set of source files.", + "id": "Source", + "properties": { + "files": { + "description": "Required. The files that comprise the source set.", + "items": { + "$ref": "File" + }, + "type": "array" + } + }, + "type": "object" + }, + "SourceLocation": { + "description": "SourceLocation references a location in a GraphQL source.", + "id": "SourceLocation", + "properties": { + "column": { + "description": "Column number starting at 1.", + "format": "int32", + "type": "integer" + }, + "line": { + "description": "Line number starting at 1.", + "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", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Firebase Data Connect API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/firebasedataconnect-v1beta.json b/discovery/firebasedataconnect-v1beta.json index d32bb65b935..aaa005ce4cd 100644 --- a/discovery/firebasedataconnect-v1beta.json +++ b/discovery/firebasedataconnect-v1beta.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1070,7 +1076,7 @@ } } }, - "revision": "20250105", + "revision": "20250323", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index 609e6f68518..a321f835372 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20250312", + "revision": "20250427", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -577,7 +577,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", + "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", "type": "object" }, "id": { @@ -865,6 +865,21 @@ "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", "format": "int32", "type": "integer" + }, + "trafficType": { + "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "ON_DEMAND", + "PROVISIONED_THROUGHPUT" + ], + "enumDescriptions": [ + "Unspecified request traffic type.", + "Type for Pay-As-You-Go traffic.", + "Type for Provisioned Throughput traffic." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -913,6 +928,10 @@ ], "type": "string" }, + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", + "description": "Optional. Config for model selection." + }, "presencePenalty": { "description": "Optional. Positive penalties.", "format": "float", @@ -974,6 +993,10 @@ "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", @@ -987,6 +1010,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig": { + "description": "Config for model selection.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", + "properties": { + "featureSelectionPreference": { + "description": "Required. Feature selection preference.", + "enum": [ + "FEATURE_SELECTION_PREFERENCE_UNSPECIFIED", + "PRIORITIZE_QUALITY", + "BALANCED", + "PRIORITIZE_COST" + ], + "enumDescriptions": [ + "Unspecified feature selection preference.", + "Prefer higher quality over lower cost.", + "Balanced feature selection preference.", + "Prefer lower cost over higher quality." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { "description": "The configuration for routing the request to a specific model.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", @@ -1030,12 +1076,24 @@ "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { - "description": "The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.", + "description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", "type": "string" } }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { + "description": "Config for thinking features.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", + "properties": { + "thinkingBudget": { + "description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", @@ -1066,6 +1124,10 @@ "description": "Chunk from context retrieved by the retrieval tools.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", "properties": { + "ragChunk": { + "$ref": "GoogleCloudAiplatformV1beta1RagChunk", + "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." + }, "text": { "description": "Text of the attribution.", "type": "string" @@ -1314,6 +1376,38 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagChunk": { + "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.", + "id": "GoogleCloudAiplatformV1beta1RagChunk", + "properties": { + "pageSpan": { + "$ref": "GoogleCloudAiplatformV1beta1RagChunkPageSpan", + "description": "If populated, represents where the chunk starts and ends in the document." + }, + "text": { + "description": "The content of the chunk.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagChunkPageSpan": { + "description": "Represents where the chunk starts and ends in the document.", + "id": "GoogleCloudAiplatformV1beta1RagChunkPageSpan", + "properties": { + "firstPage": { + "description": "Page where chunk starts in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" + }, + "lastPage": { + "description": "Page where chunk ends in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RagRetrievalConfig": { "description": "Specifies the context retrieval config.", "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfig", @@ -1391,7 +1485,7 @@ "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker", "properties": { "modelName": { - "description": "Optional. The model name used for ranking. Format: `gemini-1.5-pro`", + "description": "Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", "type": "string" } }, @@ -1474,13 +1568,21 @@ "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true + ], "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." + "Deprecated: Election filter is not longer supported. The harm category is civic integrity." ], "readOnly": true, "type": "string" @@ -1552,13 +1654,21 @@ "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true + ], "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." + "Deprecated: Election filter is not longer supported. The harm category is civic integrity." ], "type": "string" }, @@ -1603,6 +1713,10 @@ "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1beta1Schema", "properties": { + "additionalProperties": { + "description": "Optional. Can either be a boolean or an object; controls the presence of additional properties.", + "type": "any" + }, "anyOf": { "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "items": { @@ -1614,6 +1728,13 @@ "description": "Optional. Default value of the data.", "type": "any" }, + "defs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1Schema" + }, + "description": "Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.", + "type": "object" + }, "description": { "description": "Optional. The description of the data.", "type": "string" @@ -1699,6 +1820,10 @@ }, "type": "array" }, + "ref": { + "description": "Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", + "type": "string" + }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "items": { @@ -1719,7 +1844,8 @@ "INTEGER", "BOOLEAN", "ARRAY", - "OBJECT" + "OBJECT", + "NULL" ], "enumDescriptions": [ "Not specified, should not be used.", @@ -1728,7 +1854,8 @@ "OpenAPI integer type", "OpenAPI boolean type", "OpenAPI array type", - "OpenAPI object type" + "OpenAPI object type", + "Null type" ], "type": "string" } @@ -1785,6 +1912,10 @@ "description": "The speech generation config.", "id": "GoogleCloudAiplatformV1beta1SpeechConfig", "properties": { + "languageCode": { + "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", + "type": "string" + }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", "description": "The configuration for the speaker to use." @@ -1864,6 +1995,15 @@ "engine": { "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" + }, + "filter": { + "description": "Optional. Filter strings to be passed to the search API.", + "type": "string" + }, + "maxResults": { + "description": "Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.", + "format": "int32", + "type": "integer" } }, "type": "object" diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index c495b88a7a3..aaf1b788ae9 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1544,6 +1544,209 @@ ] } } + }, + "userCreds": { + "methods": { + "create": { + "description": "Create a user creds.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/userCreds", + "httpMethod": "POST", + "id": "firestore.projects.databases.userCreds.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. A parent name of the form `projects/{project_id}/databases/{database_id}`", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + }, + "userCredsId": { + "description": "Required. The ID to use for the user creds, which will become the final component of the user creds's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/userCreds", + "request": { + "$ref": "GoogleFirestoreAdminV1UserCreds" + }, + "response": { + "$ref": "GoogleFirestoreAdminV1UserCreds" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "delete": { + "description": "Deletes a user creds.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}", + "httpMethod": "DELETE", + "id": "firestore.projects.databases.userCreds.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "disable": { + "description": "Disables a user creds. No-op if the user creds are already disabled.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:disable", + "httpMethod": "POST", + "id": "firestore.projects.databases.userCreds.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:disable", + "request": { + "$ref": "GoogleFirestoreAdminV1DisableUserCredsRequest" + }, + "response": { + "$ref": "GoogleFirestoreAdminV1UserCreds" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "enable": { + "description": "Enables a user creds. No-op if the user creds are already enabled.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:enable", + "httpMethod": "POST", + "id": "firestore.projects.databases.userCreds.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:enable", + "request": { + "$ref": "GoogleFirestoreAdminV1EnableUserCredsRequest" + }, + "response": { + "$ref": "GoogleFirestoreAdminV1UserCreds" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "get": { + "description": "Gets a user creds resource. Note that the returned resource does not contain the secret value itself.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}", + "httpMethod": "GET", + "id": "firestore.projects.databases.userCreds.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleFirestoreAdminV1UserCreds" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "list": { + "description": "List all user creds in the database. Note that the returned resource does not contain the secret value itself.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/userCreds", + "httpMethod": "GET", + "id": "firestore.projects.databases.userCreds.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. A parent database name of the form `projects/{project_id}/databases/{database_id}`", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userCreds", + "response": { + "$ref": "GoogleFirestoreAdminV1ListUserCredsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "resetPassword": { + "description": "Resets the password of a user creds.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:resetPassword", + "httpMethod": "POST", + "id": "firestore.projects.databases.userCreds.resetPassword", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resetPassword", + "request": { + "$ref": "GoogleFirestoreAdminV1ResetUserPasswordRequest" + }, + "response": { + "$ref": "GoogleFirestoreAdminV1UserCreds" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + } + } } } }, @@ -1584,6 +1787,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1711,7 +1920,7 @@ } } }, - "revision": "20250307", + "revision": "20250414", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2716,6 +2925,20 @@ "readOnly": true, "type": "string" }, + "databaseEdition": { + "description": "Immutable. The edition of the database.", + "enum": [ + "DATABASE_EDITION_UNSPECIFIED", + "STANDARD", + "ENTERPRISE" + ], + "enumDescriptions": [ + "Not used.", + "Standard edition. This is the default setting if not specified.", + "Enterprise edition." + ], + "type": "string" + }, "deleteProtectionState": { "description": "State of delete protection for the database.", "enum": [ @@ -2746,6 +2969,11 @@ "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, + "freeTier": { + "description": "Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier.", + "readOnly": true, + "type": "boolean" + }, "keyPrefix": { "description": "Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID (\"~\") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).", "readOnly": true, @@ -2783,6 +3011,13 @@ "description": "Output only. Information about the provenance of this database.", "readOnly": true }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "type": "object" + }, "type": { "description": "The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.", "enum": [ @@ -2823,6 +3058,18 @@ "properties": {}, "type": "object" }, + "GoogleFirestoreAdminV1DisableUserCredsRequest": { + "description": "The request for FirestoreAdmin.DisableUserCreds.", + "id": "GoogleFirestoreAdminV1DisableUserCredsRequest", + "properties": {}, + "type": "object" + }, + "GoogleFirestoreAdminV1EnableUserCredsRequest": { + "description": "The request for FirestoreAdmin.EnableUserCreds.", + "id": "GoogleFirestoreAdminV1EnableUserCredsRequest", + "properties": {}, + "type": "object" + }, "GoogleFirestoreAdminV1EncryptionConfig": { "description": "Encryption configuration for a new database being created from another source. The source could be a Backup .", "id": "GoogleFirestoreAdminV1EncryptionConfig", @@ -3150,11 +3397,29 @@ "description": "The API scope supported by this index.", "enum": [ "ANY_API", - "DATASTORE_MODE_API" + "DATASTORE_MODE_API", + "MONGODB_COMPATIBLE_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 the Firestore in Datastore Mode query API.", + "The index can only be used by the MONGODB_COMPATIBLE_API." + ], + "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." ], "type": "string" }, @@ -3165,6 +3430,10 @@ }, "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 MONGODB_COMPATIBLE_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" @@ -3185,6 +3454,11 @@ ], "type": "string" }, + "shardCount": { + "description": "Optional. The number of shards for the index.", + "format": "int32", + "type": "integer" + }, "state": { "description": "Output only. The serving state of the index.", "enum": [ @@ -3441,6 +3715,20 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1ListUserCredsResponse": { + "description": "The response for FirestoreAdmin.ListUserCreds.", + "id": "GoogleFirestoreAdminV1ListUserCredsResponse", + "properties": { + "userCreds": { + "description": "The user creds for the database.", + "items": { + "$ref": "GoogleFirestoreAdminV1UserCreds" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1LocationMetadata": { "description": "The metadata message for google.cloud.location.Location.metadata.", "id": "GoogleFirestoreAdminV1LocationMetadata", @@ -3464,6 +3752,24 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1ResetUserPasswordRequest": { + "description": "The request for FirestoreAdmin.ResetUserPassword.", + "id": "GoogleFirestoreAdminV1ResetUserPasswordRequest", + "properties": {}, + "type": "object" + }, + "GoogleFirestoreAdminV1ResourceIdentity": { + "description": "Describes a Resource Identity principal.", + "id": "GoogleFirestoreAdminV1ResourceIdentity", + "properties": { + "principal": { + "description": "Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1RestoreDatabaseMetadata": { "description": "Metadata for the long-running operation from the RestoreDatabase request.", "id": "GoogleFirestoreAdminV1RestoreDatabaseMetadata", @@ -3532,6 +3838,13 @@ "encryptionConfig": { "$ref": "GoogleFirestoreAdminV1EncryptionConfig", "description": "Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption." + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Immutable. Tags to be bound to the restored database. The tags should be provided in the format of `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.", + "type": "object" } }, "type": "object" @@ -3633,6 +3946,53 @@ "properties": {}, "type": "object" }, + "GoogleFirestoreAdminV1UserCreds": { + "description": "A Cloud Firestore User Creds.", + "id": "GoogleFirestoreAdminV1UserCreds", + "properties": { + "createTime": { + "description": "Output only. The time the user creds were created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`", + "type": "string" + }, + "resourceIdentity": { + "$ref": "GoogleFirestoreAdminV1ResourceIdentity", + "description": "Resource Identity descriptor." + }, + "securePassword": { + "description": "Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "The default value. Should not be used.", + "The user creds are enabled.", + "The user creds are disabled." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the user creds were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1VectorConfig": { "description": "The index configuration to support vector search operations", "id": "GoogleFirestoreAdminV1VectorConfig", diff --git a/discovery/forms-v1.json b/discovery/forms-v1.json index 6d89209c289..40ba2e0e911 100644 --- a/discovery/forms-v1.json +++ b/discovery/forms-v1.json @@ -215,7 +215,7 @@ ], "parameters": { "formId": { - "description": "Required. The ID of the form. You can get the id from `Form.form_id` field.", + "description": "Required. The ID of the form. You can get the id from Form.form_id field.", "location": "path", "required": true, "type": "string" @@ -458,7 +458,7 @@ } } }, - "revision": "20250304", + "revision": "20250422", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { @@ -831,22 +831,22 @@ }, "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.", + "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 SetPublishSettings 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.", + "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. For forms that have publish_settings value set, this is the published form URI.", "readOnly": true, "type": "string" }, "revisionId": { - "description": "Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes.", + "description": "Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published)", "readOnly": true, "type": "string" }, "settings": { "$ref": "FormSettings", - "description": "The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest." + "description": "The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during CreateForm and UpdateFormInfoRequest." } }, "type": "object" @@ -1036,7 +1036,7 @@ "type": "string" }, "documentTitle": { - "description": "Output only. The title of the document which is visible in Drive. If `Info.title` is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.", + "description": "Output only. The title of the document which is visible in Drive. If Info.title is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.", "readOnly": true, "type": "string" }, @@ -1476,11 +1476,11 @@ "type": "object" }, "SetPublishSettingsResponse": { - "description": "The response of a `SetPublishSettings` request.", + "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.", + "description": "Required. The ID of the Form. This is same as the Form.form_id field.", "type": "string" }, "publishSettings": { diff --git a/discovery/games-v1.json b/discovery/games-v1.json index 7f83e67eb37..5268db4f0df 100644 --- a/discovery/games-v1.json +++ b/discovery/games-v1.json @@ -1469,7 +1469,7 @@ } } }, - "revision": "20241209", + "revision": "20250320", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { @@ -3622,6 +3622,6 @@ } }, "servicePath": "", - "title": "Google Play Game Services", + "title": "Google Play Games Services API", "version": "v1" } \ No newline at end of file diff --git a/discovery/gamesConfiguration-v1configuration.json b/discovery/gamesConfiguration-v1configuration.json index 82f99d4ca43..c41601778d3 100644 --- a/discovery/gamesConfiguration-v1configuration.json +++ b/discovery/gamesConfiguration-v1configuration.json @@ -381,7 +381,7 @@ } } }, - "revision": "20221213", + "revision": "20250320", "rootUrl": "https://gamesconfiguration.googleapis.com/", "schemas": { "AchievementConfiguration": { @@ -705,6 +705,6 @@ } }, "servicePath": "", - "title": "Google Play Game Services Publishing API", + "title": "Google Play Games Services Publishing API", "version": "v1configuration" } \ No newline at end of file diff --git a/discovery/gamesManagement-v1management.json b/discovery/gamesManagement-v1management.json index 05cb1cb91c4..142efed6ee0 100644 --- a/discovery/gamesManagement-v1management.json +++ b/discovery/gamesManagement-v1management.json @@ -471,7 +471,7 @@ } } }, - "revision": "20241209", + "revision": "20250320", "rootUrl": "https://gamesmanagement.googleapis.com/", "schemas": { "AchievementResetAllResponse": { @@ -776,6 +776,6 @@ } }, "servicePath": "", - "title": "Google Play Game Management", + "title": "Google Play Games Services Management API", "version": "v1management" } \ No newline at end of file diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index 6735ae03eaa..91312b303d8 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -177,6 +183,260 @@ } }, "resources": { + "backupChannels": { + "methods": { + "create": { + "description": "Creates a new BackupChannel in a given location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels", + "httpMethod": "POST", + "id": "gkebackup.projects.locations.backupChannels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backupChannelId": { + "description": "Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location within which to create the BackupChannel. Format: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupChannels", + "request": { + "$ref": "BackupChannel" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an existing BackupChannel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}", + "httpMethod": "DELETE", + "id": "gkebackup.projects.locations.backupChannels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If provided, this value must match the current value of the target BackupChannel's etag field or the request is rejected.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any BackupPlanAssociations below this BackupChannel will also be deleted. Otherwise, the request will only succeed if the BackupChannel has no BackupPlanAssociations.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Fully qualified BackupChannel name. Format: `projects/*/locations/*/backupChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieve the details of a single BackupChannel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.backupChannels.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Fully qualified BackupChannel name. Format: `projects/*/locations/*/backupChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "BackupChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BackupChannels in a given location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.backupChannels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Field match expression used to filter the results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value of next_page_token received from a previous `ListBackupChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupChannels` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location that contains the BackupChannels to list. Format: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupChannels", + "response": { + "$ref": "ListBackupChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a BackupChannel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}", + "httpMethod": "PATCH", + "id": "gkebackup.projects.locations.backupChannels.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The fully qualified name of the BackupChannel. `projects/*/locations/*/backupChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. This is used to specify the fields to be overwritten in the BackupChannel targeted for update. The values for each of these updated fields will be taken from the `backup_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `labels`, etc.) If no `update_mask` is provided, all fields in `backup_channel` will be written to the target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_channel` are ignored and are not used to update the target BackupChannel.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "BackupChannel" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "backupPlanBindings": { + "methods": { + "get": { + "description": "Retrieve the details of a single BackupPlanBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings/{backupPlanBindingsId}", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.backupChannels.backupPlanBindings.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Fully qualified BackupPlanBinding name. Format: `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+/backupPlanBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "BackupPlanBinding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BackupPlanBindings in a given location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.backupChannels.backupPlanBindings.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Field match expression used to filter the results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value of next_page_token received from a previous `ListBackupPlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlanBindings` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects/*/locations/*/backupChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupPlanBindings", + "response": { + "$ref": "ListBackupPlanBindingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "backupPlans": { "methods": { "create": { @@ -1019,6 +1279,255 @@ } } }, + "restoreChannels": { + "methods": { + "create": { + "description": "Creates a new RestoreChannel in a given location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels", + "httpMethod": "POST", + "id": "gkebackup.projects.locations.restoreChannels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location within which to create the RestoreChannel. Format: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "restoreChannelId": { + "description": "Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/restoreChannels", + "request": { + "$ref": "RestoreChannel" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an existing RestoreChannel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}", + "httpMethod": "DELETE", + "id": "gkebackup.projects.locations.restoreChannels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If provided, this value must match the current value of the target RestoreChannel's etag field or the request is rejected.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Fully qualified RestoreChannel name. Format: `projects/*/locations/*/restoreChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieve the details of a single RestoreChannel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.restoreChannels.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Fully qualified RestoreChannel name. Format: `projects/*/locations/*/restoreChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "RestoreChannel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RestoreChannels in a given location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.restoreChannels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Field match expression used to filter the results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value of next_page_token received from a previous `ListRestoreChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestoreChannels` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location that contains the RestoreChannels to list. Format: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/restoreChannels", + "response": { + "$ref": "ListRestoreChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a RestoreChannel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}", + "httpMethod": "PATCH", + "id": "gkebackup.projects.locations.restoreChannels.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The fully qualified name of the RestoreChannel. `projects/*/locations/*/restoreChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. This is used to specify the fields to be overwritten in the RestoreChannel targeted for update. The values for each of these updated fields will be taken from the `restore_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `destination_project_id`, etc.) If no `update_mask` is provided, all fields in `restore_channel` will be written to the target RestoreChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_channel` are ignored and are not used to update the target RestoreChannel.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "RestoreChannel" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "restorePlanBindings": { + "methods": { + "get": { + "description": "Retrieve the details of a single RestorePlanBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings/{restorePlanBindingsId}", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.restoreChannels.restorePlanBindings.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Fully qualified RestorePlanBinding name. Format: `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+/restorePlanBindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "RestorePlanBinding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RestorePlanBindings in a given location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings", + "httpMethod": "GET", + "id": "gkebackup.projects.locations.restoreChannels.restorePlanBindings.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Field match expression used to filter the results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value of next_page_token received from a previous `ListRestorePlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestorePlanBindings` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: `projects/*/locations/*/restoreChannels/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/restorePlanBindings", + "response": { + "$ref": "ListRestorePlanBindingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "restorePlans": { "methods": { "create": { @@ -1718,7 +2227,7 @@ } } }, - "revision": "20250305", + "revision": "20250414", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -1928,27 +2437,80 @@ "readOnly": true, "type": "string" }, - "stateReason": { - "description": "Output only. Human-readable description of why the backup is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.", + "stateReason": { + "description": "Output only. Human-readable description of why the backup is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.", + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when this Backup resource was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "volumeCount": { + "description": "Output only. The total number of volume backups contained in the Backup.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "BackupChannel": { + "description": "A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project.", + "id": "BackupChannel", + "properties": { + "createTime": { + "description": "Output only. The timestamp when this BackupChannel resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. User specified descriptive string for this BackupChannel.", + "type": "string" + }, + "destinationProject": { + "description": "Required. Immutable. The project where Backups are allowed to be stored. The format is `projects/{project}`. Currently, {project} can only be the project number. Support for project IDs will be added in the future.", + "type": "string" + }, + "destinationProjectId": { + "description": "Output only. The project_id where Backups are allowed to be stored. Example Project ID: \"my-project-id\". This will be an OUTPUT_ONLY field to return the project_id of the destination project.", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupChannel`, and systems are expected to put that etag in the request to `UpdateBackupChannel` or `DeleteBackupChannel` to ensure that their change will be applied to the same version of the resource.", "readOnly": true, "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A set of custom labels supplied by user.", + "type": "object" + }, + "name": { + "description": "Identifier. The fully qualified name of the BackupChannel. `projects/*/locations/*/backupChannels/*`", + "type": "string" + }, "uid": { - "description": "Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)", + "description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.", "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. The timestamp when this Backup resource was last updated.", + "description": "Output only. The timestamp when this BackupChannel resource was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" - }, - "volumeCount": { - "description": "Output only. The total number of volume backups contained in the Backup.", - "format": "int32", - "readOnly": true, - "type": "integer" } }, "type": "object" @@ -2104,6 +2666,113 @@ }, "type": "object" }, + "BackupPlanBinding": { + "description": "A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.", + "id": "BackupPlanBinding", + "properties": { + "backupPlan": { + "description": "Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/*/locations/*/backupPlans/{backup_plan}`", + "readOnly": true, + "type": "string" + }, + "backupPlanDetails": { + "$ref": "BackupPlanDetails", + "description": "Output only. Contains details about the backup plan/backup.", + "readOnly": true + }, + "cluster": { + "description": "Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp when this binding was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlanBinding`, and systems are expected to put that etag in the request to `UpdateBackupPlanBinding` or `DeleteBackupPlanBinding` to ensure that their change will be applied to the same version of the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The fully qualified name of the BackupPlanBinding. `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`", + "type": "string" + }, + "uid": { + "description": "Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when this binding was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupPlanDetails": { + "description": "Contains metadata about the backup plan/backup.", + "id": "BackupPlanDetails", + "properties": { + "lastSuccessfulBackup": { + "description": "Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/*/locations/*/backupPlans/*/backups/*`", + "readOnly": true, + "type": "string" + }, + "lastSuccessfulBackupTime": { + "description": "Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "nextScheduledBackupTime": { + "description": "Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "protectedPodCount": { + "description": "Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "rpoRiskLevel": { + "description": "Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "state": { + "description": "Output only. State of the BackupPlan.", + "enum": [ + "STATE_UNSPECIFIED", + "CLUSTER_PENDING", + "PROVISIONING", + "READY", + "FAILED", + "DEACTIVATED", + "DELETING" + ], + "enumDescriptions": [ + "Default first value for Enums.", + "Waiting for cluster state to be RUNNING.", + "The BackupPlan is in the process of being created.", + "The BackupPlan has successfully been created and is ready for Backups.", + "BackupPlan creation has failed.", + "The BackupPlan has been deactivated.", + "The BackupPlan is in the process of being deleted." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -2340,6 +3009,7 @@ "id": "GetBackupIndexDownloadUrlResponse", "properties": { "signedUrl": { + "description": "Required. The signed URL for downloading the backup index.", "type": "string" } }, @@ -2461,6 +3131,56 @@ }, "type": "object" }, + "ListBackupChannelsResponse": { + "description": "Response message for ListBackupChannels.", + "id": "ListBackupChannelsResponse", + "properties": { + "backupChannels": { + "description": "The list of BackupChannels matching the given criteria.", + "items": { + "$ref": "BackupChannel" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token which may be sent as page_token in a subsequent `ListBackupChannels` 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" + }, + "ListBackupPlanBindingsResponse": { + "description": "Response message for ListBackupPlanBindings.", + "id": "ListBackupPlanBindingsResponse", + "properties": { + "backupPlanBindings": { + "description": "The list of BackupPlanBindings matching the given criteria.", + "items": { + "$ref": "BackupPlanBinding" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token which may be sent as page_token in a subsequent `ListBackupPlanBindingss` 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" + }, "ListBackupPlansResponse": { "description": "Response message for ListBackupPlans.", "id": "ListBackupPlansResponse", @@ -2529,6 +3249,56 @@ }, "type": "object" }, + "ListRestoreChannelsResponse": { + "description": "Response message for ListRestoreChannels.", + "id": "ListRestoreChannelsResponse", + "properties": { + "nextPageToken": { + "description": "A token which may be sent as page_token in a subsequent `ListRestoreChannels` 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" + }, + "restoreChannels": { + "description": "The list of RestoreChannels matching the given criteria.", + "items": { + "$ref": "RestoreChannel" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRestorePlanBindingsResponse": { + "description": "Response message for ListRestorePlanBindings.", + "id": "ListRestorePlanBindingsResponse", + "properties": { + "nextPageToken": { + "description": "A token which may be sent as page_token in a subsequent `ListRestorePlanBindings` 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" + }, + "restorePlanBindings": { + "description": "The list of RestorePlanBindings matching the given criteria.", + "items": { + "$ref": "RestorePlanBinding" + }, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListRestorePlansResponse": { "description": "Response message for ListRestorePlans.", "id": "ListRestorePlansResponse", @@ -2844,7 +3614,7 @@ "type": "string" }, "description": { - "description": "User specified descriptive string for this Restore.", + "description": "Optional. User specified descriptive string for this Restore.", "type": "string" }, "etag": { @@ -2946,6 +3716,59 @@ }, "type": "object" }, + "RestoreChannel": { + "description": "A RestoreChannel imposes constraints on where backups can be restored. The RestoreChannel should be in the same project and region as the backups. The backups can only be restored in the `destination_project`.", + "id": "RestoreChannel", + "properties": { + "createTime": { + "description": "Output only. The timestamp when this RestoreChannel was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. User specified descriptive string for this RestoreChannel.", + "type": "string" + }, + "destinationProject": { + "description": "Required. Immutable. The project into which the backups will be restored. The format is `projects/{project}`. Currently, {project} can only be the project number. Support for project IDs will be added in the future.", + "type": "string" + }, + "destinationProjectId": { + "description": "Output only. The project_id where backups will be restored. Example Project ID: \"my-project-id\". This will be an OUTPUT_ONLY field to return the project_id of the destination project.", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestoreChannel`, and systems are expected to put that etag in the request to `UpdateRestoreChannel` or `DeleteRestoreChannel` to ensure that their change will be applied to the same version of the resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A set of custom labels supplied by user.", + "type": "object" + }, + "name": { + "description": "Identifier. The fully qualified name of the RestoreChannel. `projects/*/locations/*/restoreChannels/*`", + "type": "string" + }, + "uid": { + "description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when this RestoreChannel was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "RestoreConfig": { "description": "Configuration of a restore.", "id": "RestoreConfig", @@ -3147,6 +3970,49 @@ }, "type": "object" }, + "RestorePlanBinding": { + "description": "A RestorePlanBinding binds a RestorePlan with a RestoreChannel. This resource is created automatically when a RestorePlan is created using a RestoreChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.", + "id": "RestorePlanBinding", + "properties": { + "backupPlan": { + "description": "Output only. The fully qualified name of the BackupPlan bound to the specified RestorePlan. `projects/*/locations/*/backukpPlans/{backup_plan}`", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp when this binding was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestorePlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestorePlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlanBinding`, and systems are expected to put that etag in the request to `UpdateRestorePlanBinding` or `DeleteRestorePlanBinding` to ensure that their change will be applied to the same version of the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The fully qualified name of the RestorePlanBinding. `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`", + "type": "string" + }, + "restorePlan": { + "description": "Output only. The fully qualified name of the RestorePlan bound to this RestoreChannel. `projects/*/locations/*/restorePlans/{restore_plan}`", + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when this binding was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "RetentionPolicy": { "description": "RetentionPolicy defines a Backup retention policy for a BackupPlan.", "id": "RetentionPolicy", diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index ab2e6e63042..6122da64d41 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -191,6 +191,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2111,7 +2117,7 @@ } } }, - "revision": "20250302", + "revision": "20250423", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2552,6 +2558,10 @@ "multiclusteringress": { "$ref": "MultiClusterIngressFeatureSpec", "description": "Multicluster Ingress-specific spec." + }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationFeatureSpec", + "description": "RBAC Role Binding Actuation feature spec" } }, "type": "object" @@ -2572,6 +2582,10 @@ "$ref": "FleetObservabilityFeatureState", "description": "FleetObservability feature state." }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationFeatureState", + "description": "RBAC Role Binding Actuation feature state" + }, "state": { "$ref": "FeatureState", "description": "Output only. The \"running state\" of the Feature in this Fleet.", @@ -4991,7 +5005,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Labels for this membership.", + "description": "Optional. Labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types.", "type": "object" }, "lastConnectionTime": { @@ -5983,6 +5997,26 @@ }, "type": "object" }, + "RBACRoleBindingActuationFeatureSpec": { + "description": "**RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature.", + "id": "RBACRoleBindingActuationFeatureSpec", + "properties": { + "allowedCustomRoles": { + "description": "The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RBACRoleBindingActuationFeatureState": { + "description": "**RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state.", + "id": "RBACRoleBindingActuationFeatureState", + "properties": {}, + "type": "object" + }, "RBACRoleBindingLifecycleState": { "description": "RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource.", "id": "RBACRoleBindingLifecycleState", @@ -6049,6 +6083,10 @@ "description": "Role is the type for Kubernetes roles", "id": "Role", "properties": { + "customRole": { + "description": "Optional. custom_role is the name of a custom KubernetesClusterRole to use.", + "type": "string" + }, "predefinedRole": { "description": "predefined_role is the Kubernetes default role to use", "enum": [ @@ -6207,7 +6245,7 @@ "type": "object" }, "ServiceMeshCondition": { - "description": "Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message.", + "description": "Condition being reported.", "id": "ServiceMeshCondition", "properties": { "code": { @@ -6245,6 +6283,11 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "LEGACY_MC_SECRETS", + "WORKLOAD_IDENTITY_REQUIRED", + "NON_STANDARD_BINARY_USAGE", + "UNSUPPORTED_GATEWAY_CLASS", + "MANAGED_CNI_NOT_ENABLED", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -6284,6 +6327,11 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", + "Legacy istio secrets found for multicluster error code", + "Workload identity required error code", + "Non-standard binary usage error code", + "Unsupported gateway class error code", + "Managed CNI not enabled error code", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", @@ -6467,7 +6515,7 @@ "id": "ServiceMeshMembershipState", "properties": { "conditions": { - "description": "Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message.", + "description": "Output only. List of conditions reported for this membership.", "items": { "$ref": "ServiceMeshCondition" }, diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index ab4c23c3fca..8a4bdff1092 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -191,6 +191,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2255,7 +2261,7 @@ } } }, - "revision": "20250302", + "revision": "20250423", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2801,9 +2807,17 @@ "$ref": "NamespaceActuationFeatureSpec", "description": "Namespace Actuation feature spec" }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationFeatureSpec", + "description": "RBAC Role Binding Actuation feature spec" + }, "workloadcertificate": { "$ref": "FeatureSpec", "description": "Workload Certificate spec." + }, + "workloadidentity": { + "$ref": "WorkloadIdentityFeatureSpec", + "description": "Workload Identity feature spec." } }, "type": "object" @@ -2828,6 +2842,10 @@ "$ref": "NamespaceActuationFeatureState", "description": "Namespace Actuation feature state." }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationFeatureState", + "description": "RBAC Role Binding Actuation feature state" + }, "servicemesh": { "$ref": "ServiceMeshFeatureState", "description": "Service Mesh-specific state." @@ -2836,6 +2854,10 @@ "$ref": "FeatureState", "description": "Output only. The \"running state\" of the Feature in this Fleet.", "readOnly": true + }, + "workloadidentity": { + "$ref": "WorkloadIdentityFeatureState", + "description": "WorkloadIdentity fleet-level state." } }, "type": "object" @@ -5381,7 +5403,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Labels for this membership.", + "description": "Optional. Labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types.", "type": "object" }, "lastConnectionTime": { @@ -5621,6 +5643,10 @@ "state": { "$ref": "FeatureState", "description": "The high-level state of this Feature for a single membership." + }, + "workloadidentity": { + "$ref": "WorkloadIdentityMembershipState", + "description": "Workload Identity membership specific state." } }, "type": "object" @@ -6485,6 +6511,26 @@ }, "type": "object" }, + "RBACRoleBindingActuationFeatureSpec": { + "description": "**RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature.", + "id": "RBACRoleBindingActuationFeatureSpec", + "properties": { + "allowedCustomRoles": { + "description": "The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RBACRoleBindingActuationFeatureState": { + "description": "**RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state.", + "id": "RBACRoleBindingActuationFeatureState", + "properties": {}, + "type": "object" + }, "RBACRoleBindingLifecycleState": { "description": "RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource.", "id": "RBACRoleBindingLifecycleState", @@ -6551,6 +6597,10 @@ "description": "Role is the type for Kubernetes roles", "id": "Role", "properties": { + "customRole": { + "description": "Optional. custom_role is the name of a custom KubernetesClusterRole to use.", + "type": "string" + }, "predefinedRole": { "description": "predefined_role is the Kubernetes default role to use", "enum": [ @@ -6779,7 +6829,7 @@ "type": "object" }, "ServiceMeshCondition": { - "description": "Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message.", + "description": "Condition being reported.", "id": "ServiceMeshCondition", "properties": { "code": { @@ -6817,6 +6867,11 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "LEGACY_MC_SECRETS", + "WORKLOAD_IDENTITY_REQUIRED", + "NON_STANDARD_BINARY_USAGE", + "UNSUPPORTED_GATEWAY_CLASS", + "MANAGED_CNI_NOT_ENABLED", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -6856,6 +6911,11 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", + "Legacy istio secrets found for multicluster error code", + "Workload identity required error code", + "Non-standard binary usage error code", + "Unsupported gateway class error code", + "Managed CNI not enabled error code", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", @@ -6985,7 +7045,7 @@ "type": "object" }, "ServiceMeshFeatureCondition": { - "description": "Condition being reported. TODO b/395151419: This message should be used to replace the membership-level Condition message.", + "description": "Condition being reported.", "id": "ServiceMeshFeatureCondition", "properties": { "code": { @@ -7023,6 +7083,11 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "LEGACY_MC_SECRETS", + "WORKLOAD_IDENTITY_REQUIRED", + "NON_STANDARD_BINARY_USAGE", + "UNSUPPORTED_GATEWAY_CLASS", + "MANAGED_CNI_NOT_ENABLED", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -7062,6 +7127,11 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", + "Legacy istio secrets found for multicluster error code.", + "Workload identity required error code.", + "Non-standard binary usage error code.", + "Unsupported gateway class error code.", + "Managed CNI not enabled error code.", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", @@ -7200,7 +7270,7 @@ "type": "array" }, "conditions": { - "description": "Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message.", + "description": "Output only. List of conditions reported for this membership.", "items": { "$ref": "ServiceMeshCondition" }, @@ -7410,6 +7480,124 @@ } }, "type": "object" + }, + "WorkloadIdentityFeatureSpec": { + "description": "**WorkloadIdentity**: Global feature specification.", + "id": "WorkloadIdentityFeatureSpec", + "properties": { + "scopeTenancyPool": { + "description": "Pool to be used for Workload Identity. This pool in trust-domain mode is used with Fleet Tenancy, so that sameness can be enforced. ex: projects/example/locations/global/workloadidentitypools/custompool", + "type": "string" + } + }, + "type": "object" + }, + "WorkloadIdentityFeatureState": { + "description": "**WorkloadIdentity**: Global feature state.", + "id": "WorkloadIdentityFeatureState", + "properties": { + "namespaceStateDetails": { + "additionalProperties": { + "$ref": "WorkloadIdentityNamespaceStateDetail" + }, + "description": "The state of the IAM namespaces for the fleet.", + "type": "object" + }, + "namespaceStates": { + "additionalProperties": { + "enum": [ + "NAMESPACE_STATE_UNSPECIFIED", + "NAMESPACE_STATE_OK", + "NAMESPACE_STATE_ERROR" + ], + "enumDescriptions": [ + "Unknown state.", + "The Namespace was created/updated successfully.", + "The Namespace was not created/updated successfully. The error message is in the description field." + ], + "type": "string" + }, + "description": "Deprecated, will erase after code is changed to use the new field.", + "type": "object" + }, + "scopeTenancyWorkloadIdentityPool": { + "description": "The full name of the scope-tenancy pool for the fleet.", + "type": "string" + }, + "workloadIdentityPool": { + "description": "The full name of the svc.id.goog pool for the fleet.", + "type": "string" + }, + "workloadIdentityPoolStateDetails": { + "additionalProperties": { + "$ref": "WorkloadIdentityWorkloadIdentityPoolStateDetail" + }, + "description": "The state of the Workload Identity Pools for the fleet.", + "type": "object" + } + }, + "type": "object" + }, + "WorkloadIdentityMembershipState": { + "description": "**WorkloadIdentity**: The membership-specific state for WorkloadIdentity feature.", + "id": "WorkloadIdentityMembershipState", + "properties": { + "description": { + "description": "Deprecated, will erase after code is changed to use the new field.", + "type": "string" + } + }, + "type": "object" + }, + "WorkloadIdentityNamespaceStateDetail": { + "description": "NamespaceStateDetail represents the state of a IAM namespace.", + "id": "WorkloadIdentityNamespaceStateDetail", + "properties": { + "code": { + "description": "The state of the IAM namespace.", + "enum": [ + "NAMESPACE_STATE_UNSPECIFIED", + "NAMESPACE_STATE_OK", + "NAMESPACE_STATE_ERROR" + ], + "enumDescriptions": [ + "Unknown state.", + "The Namespace was created/updated successfully.", + "The Namespace was not created/updated successfully. The error message is in the description field." + ], + "type": "string" + }, + "description": { + "description": "A human-readable description of the current state or returned error.", + "type": "string" + } + }, + "type": "object" + }, + "WorkloadIdentityWorkloadIdentityPoolStateDetail": { + "description": "WorkloadIdentityPoolStateDetail represents the state of the Workload Identity Pools for the fleet.", + "id": "WorkloadIdentityWorkloadIdentityPoolStateDetail", + "properties": { + "code": { + "description": "The state of the Workload Identity Pool.", + "enum": [ + "WORKLOAD_IDENTITY_POOL_STATE_UNSPECIFIED", + "WORKLOAD_IDENTITY_POOL_STATE_OK", + "WORKLOAD_IDENTITY_POOL_STATE_ERROR" + ], + "enumDescriptions": [ + "Unknown state.", + "The Workload Identity Pool was created/updated successfully.", + "The Workload Identity Pool was not created/updated successfully. The error message is in the description field." + ], + "type": "string" + }, + "description": { + "description": "A human-readable description of the current state or returned error.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index f468a68ce3f..cef9a78c608 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -191,6 +191,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2111,7 +2117,7 @@ } } }, - "revision": "20250302", + "revision": "20250421", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2552,6 +2558,10 @@ "multiclusteringress": { "$ref": "MultiClusterIngressFeatureSpec", "description": "Multicluster Ingress-specific spec." + }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationFeatureSpec", + "description": "RBAC Role Binding Actuation feature spec" } }, "type": "object" @@ -2572,6 +2582,10 @@ "$ref": "FleetObservabilityFeatureState", "description": "FleetObservability feature state." }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationFeatureState", + "description": "RBAC Role Binding Actuation feature state" + }, "state": { "$ref": "FeatureState", "description": "Output only. The \"running state\" of the Feature in this Fleet.", @@ -5052,7 +5066,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Labels for this membership.", + "description": "Optional. Labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types.", "type": "object" }, "lastConnectionTime": { @@ -6109,6 +6123,26 @@ }, "type": "object" }, + "RBACRoleBindingActuationFeatureSpec": { + "description": "**RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature.", + "id": "RBACRoleBindingActuationFeatureSpec", + "properties": { + "allowedCustomRoles": { + "description": "The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RBACRoleBindingActuationFeatureState": { + "description": "**RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state.", + "id": "RBACRoleBindingActuationFeatureState", + "properties": {}, + "type": "object" + }, "RBACRoleBindingLifecycleState": { "description": "RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource.", "id": "RBACRoleBindingLifecycleState", @@ -6175,6 +6209,10 @@ "description": "Role is the type for Kubernetes roles", "id": "Role", "properties": { + "customRole": { + "description": "Optional. custom_role is the name of a custom KubernetesClusterRole to use.", + "type": "string" + }, "predefinedRole": { "description": "predefined_role is the Kubernetes default role to use", "enum": [ @@ -6333,7 +6371,7 @@ "type": "object" }, "ServiceMeshCondition": { - "description": "Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message.", + "description": "Condition being reported.", "id": "ServiceMeshCondition", "properties": { "code": { @@ -6371,6 +6409,11 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "LEGACY_MC_SECRETS", + "WORKLOAD_IDENTITY_REQUIRED", + "NON_STANDARD_BINARY_USAGE", + "UNSUPPORTED_GATEWAY_CLASS", + "MANAGED_CNI_NOT_ENABLED", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -6410,6 +6453,11 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", + "Legacy istio secrets found for multicluster error code", + "Workload identity required error code", + "Non-standard binary usage error code", + "Unsupported gateway class error code", + "Managed CNI not enabled error code", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", @@ -6593,7 +6641,7 @@ "id": "ServiceMeshMembershipState", "properties": { "conditions": { - "description": "Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message.", + "description": "Output only. List of conditions reported for this membership.", "items": { "$ref": "ServiceMeshCondition" }, diff --git a/discovery/gkehub-v1beta1.json b/discovery/gkehub-v1beta1.json index f2780198ce1..da386b11434 100644 --- a/discovery/gkehub-v1beta1.json +++ b/discovery/gkehub-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -712,7 +718,7 @@ } } }, - "revision": "20241206", + "revision": "20250415", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { @@ -1182,7 +1188,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. GCP labels for this membership.", + "description": "Optional. GCP labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types.", "type": "object" }, "lastConnectionTime": { diff --git a/discovery/gkehub-v2.json b/discovery/gkehub-v2.json index 757cd19c241..4e23fc99326 100644 --- a/discovery/gkehub-v2.json +++ b/discovery/gkehub-v2.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -471,7 +477,7 @@ } } }, - "revision": "20250302", + "revision": "20250415", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -1762,6 +1768,10 @@ "$ref": "PolicyControllerSpec", "description": "Policycontroller-specific FeatureSpec." }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationSpec", + "description": "Rbacrolebindingactuation-specific FeatureSpec." + }, "servicemesh": { "$ref": "ServiceMeshSpec", "description": "ServiceMesh Feature Spec." @@ -1801,6 +1811,10 @@ "$ref": "PolicyControllerState", "description": "Policy Controller state" }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationState", + "description": "RBAC Role Binding Actuation state" + }, "servicemesh": { "$ref": "ServiceMeshState", "description": "Service mesh state" @@ -2888,6 +2902,58 @@ }, "type": "object" }, + "RBACRoleBindingActuationRBACRoleBindingState": { + "description": "RBACRoleBindingState is the status of an RBACRoleBinding which exists on a membership.", + "id": "RBACRoleBindingActuationRBACRoleBindingState", + "properties": { + "description": { + "description": "The reason for the failure.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the RBACRoleBinding.", + "enum": [ + "ROLE_BINDING_STATE_UNSPECIFIED", + "OK", + "CUSTOM_ROLE_MISSING_FROM_CLUSTER" + ], + "enumDescriptions": [ + "Unspecified state.", + "RBACRoleBinding is created properly on the cluster.", + "The RBACRoleBinding was created on the cluster but the specified custom role does not exist on the cluster, hence the RBACRoleBinding has no effect." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "The time the RBACRoleBinding status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RBACRoleBindingActuationSpec": { + "description": "**RBAC RoleBinding Actuation**: The membership-specific input for RBACRoleBindingActuation feature.", + "id": "RBACRoleBindingActuationSpec", + "properties": {}, + "type": "object" + }, + "RBACRoleBindingActuationState": { + "description": "**RBAC RoleBinding Actuation**: A membership-specific Feature state for the RBACRoleBindingActuation fleet feature.", + "id": "RBACRoleBindingActuationState", + "properties": { + "rbacrolebindingStates": { + "additionalProperties": { + "$ref": "RBACRoleBindingActuationRBACRoleBindingState" + }, + "description": "Output only. The state of RBACRoleBindings using custom roles that exist on the cluster, keyed by RBACRoleBinding resource name with format: projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, "ServiceMeshAnalysisMessage": { "description": "AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.", "id": "ServiceMeshAnalysisMessage", @@ -2988,6 +3054,11 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "LEGACY_MC_SECRETS", + "WORKLOAD_IDENTITY_REQUIRED", + "NON_STANDARD_BINARY_USAGE", + "UNSUPPORTED_GATEWAY_CLASS", + "MANAGED_CNI_NOT_ENABLED", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -3027,6 +3098,11 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", + "Legacy istio secrets found for multicluster error code", + "Workload identity required error code", + "Non-standard binary usage error code", + "Unsupported gateway class error code", + "Managed CNI not enabled error code", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", diff --git a/discovery/gkehub-v2alpha.json b/discovery/gkehub-v2alpha.json index 1484f80a8fb..cab771a886c 100644 --- a/discovery/gkehub-v2alpha.json +++ b/discovery/gkehub-v2alpha.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -471,7 +477,7 @@ } } }, - "revision": "20250302", + "revision": "20250415", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -1762,6 +1768,10 @@ "$ref": "PolicyControllerSpec", "description": "Policycontroller-specific FeatureSpec." }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationSpec", + "description": "Rbacrolebindingactuation-specific FeatureSpec." + }, "servicemesh": { "$ref": "ServiceMeshSpec", "description": "ServiceMesh Feature Spec." @@ -1801,6 +1811,10 @@ "$ref": "PolicyControllerState", "description": "Policy Controller state" }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationState", + "description": "RBAC Role Binding Actuation state" + }, "servicemesh": { "$ref": "ServiceMeshState", "description": "Service mesh state" @@ -2888,6 +2902,58 @@ }, "type": "object" }, + "RBACRoleBindingActuationRBACRoleBindingState": { + "description": "RBACRoleBindingState is the status of an RBACRoleBinding which exists on a membership.", + "id": "RBACRoleBindingActuationRBACRoleBindingState", + "properties": { + "description": { + "description": "The reason for the failure.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the RBACRoleBinding.", + "enum": [ + "ROLE_BINDING_STATE_UNSPECIFIED", + "OK", + "CUSTOM_ROLE_MISSING_FROM_CLUSTER" + ], + "enumDescriptions": [ + "Unspecified state.", + "RBACRoleBinding is created properly on the cluster.", + "The RBACRoleBinding was created on the cluster but the specified custom role does not exist on the cluster, hence the RBACRoleBinding has no effect." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "The time the RBACRoleBinding status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RBACRoleBindingActuationSpec": { + "description": "**RBAC RoleBinding Actuation**: The membership-specific input for RBACRoleBindingActuation feature.", + "id": "RBACRoleBindingActuationSpec", + "properties": {}, + "type": "object" + }, + "RBACRoleBindingActuationState": { + "description": "**RBAC RoleBinding Actuation**: A membership-specific Feature state for the RBACRoleBindingActuation fleet feature.", + "id": "RBACRoleBindingActuationState", + "properties": { + "rbacrolebindingStates": { + "additionalProperties": { + "$ref": "RBACRoleBindingActuationRBACRoleBindingState" + }, + "description": "Output only. The state of RBACRoleBindings using custom roles that exist on the cluster, keyed by RBACRoleBinding resource name with format: projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, "ServiceMeshAnalysisMessage": { "description": "AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.", "id": "ServiceMeshAnalysisMessage", @@ -2988,6 +3054,11 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "LEGACY_MC_SECRETS", + "WORKLOAD_IDENTITY_REQUIRED", + "NON_STANDARD_BINARY_USAGE", + "UNSUPPORTED_GATEWAY_CLASS", + "MANAGED_CNI_NOT_ENABLED", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -3027,6 +3098,11 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", + "Legacy istio secrets found for multicluster error code", + "Workload identity required error code", + "Non-standard binary usage error code", + "Unsupported gateway class error code", + "Managed CNI not enabled error code", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", diff --git a/discovery/gkehub-v2beta.json b/discovery/gkehub-v2beta.json index b940f7619aa..c10fcb4312f 100644 --- a/discovery/gkehub-v2beta.json +++ b/discovery/gkehub-v2beta.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -471,7 +477,7 @@ } } }, - "revision": "20250302", + "revision": "20250415", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -1762,6 +1768,10 @@ "$ref": "PolicyControllerSpec", "description": "Policycontroller-specific FeatureSpec." }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationSpec", + "description": "Rbacrolebindingactuation-specific FeatureSpec." + }, "servicemesh": { "$ref": "ServiceMeshSpec", "description": "ServiceMesh Feature Spec." @@ -1801,6 +1811,10 @@ "$ref": "PolicyControllerState", "description": "Policy Controller state" }, + "rbacrolebindingactuation": { + "$ref": "RBACRoleBindingActuationState", + "description": "RBAC Role Binding Actuation state" + }, "servicemesh": { "$ref": "ServiceMeshState", "description": "Service mesh state" @@ -2888,6 +2902,58 @@ }, "type": "object" }, + "RBACRoleBindingActuationRBACRoleBindingState": { + "description": "RBACRoleBindingState is the status of an RBACRoleBinding which exists on a membership.", + "id": "RBACRoleBindingActuationRBACRoleBindingState", + "properties": { + "description": { + "description": "The reason for the failure.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the RBACRoleBinding.", + "enum": [ + "ROLE_BINDING_STATE_UNSPECIFIED", + "OK", + "CUSTOM_ROLE_MISSING_FROM_CLUSTER" + ], + "enumDescriptions": [ + "Unspecified state.", + "RBACRoleBinding is created properly on the cluster.", + "The RBACRoleBinding was created on the cluster but the specified custom role does not exist on the cluster, hence the RBACRoleBinding has no effect." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "The time the RBACRoleBinding status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RBACRoleBindingActuationSpec": { + "description": "**RBAC RoleBinding Actuation**: The membership-specific input for RBACRoleBindingActuation feature.", + "id": "RBACRoleBindingActuationSpec", + "properties": {}, + "type": "object" + }, + "RBACRoleBindingActuationState": { + "description": "**RBAC RoleBinding Actuation**: A membership-specific Feature state for the RBACRoleBindingActuation fleet feature.", + "id": "RBACRoleBindingActuationState", + "properties": { + "rbacrolebindingStates": { + "additionalProperties": { + "$ref": "RBACRoleBindingActuationRBACRoleBindingState" + }, + "description": "Output only. The state of RBACRoleBindings using custom roles that exist on the cluster, keyed by RBACRoleBinding resource name with format: projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, "ServiceMeshAnalysisMessage": { "description": "AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.", "id": "ServiceMeshAnalysisMessage", @@ -2988,6 +3054,11 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "LEGACY_MC_SECRETS", + "WORKLOAD_IDENTITY_REQUIRED", + "NON_STANDARD_BINARY_USAGE", + "UNSUPPORTED_GATEWAY_CLASS", + "MANAGED_CNI_NOT_ENABLED", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -3027,6 +3098,11 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", + "Legacy istio secrets found for multicluster error code", + "Workload identity required error code", + "Non-standard binary usage error code", + "Unsupported gateway class error code", + "Managed CNI not enabled error code", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index 6ee1801bef1..98dd687ae51 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -3094,7 +3100,7 @@ } } }, - "revision": "20250224", + "revision": "20250326", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -5619,6 +5625,10 @@ "description": "A human readable description of this VMware admin cluster.", "type": "string" }, + "enableAdvancedCluster": { + "description": "Enable advanced cluster.", + "type": "boolean" + }, "endpoint": { "description": "Output only. The DNS name of VMware admin cluster's API server.", "readOnly": true, @@ -6094,6 +6104,10 @@ "description": "Disable bundled ingress.", "type": "boolean" }, + "enableAdvancedCluster": { + "description": "Enable advanced cluster.", + "type": "boolean" + }, "enableControlPlaneV2": { "description": "Enable control plane V2. Default to false.", "type": "boolean" diff --git a/discovery/gmail-v1.json b/discovery/gmail-v1.json index 1ec8882b7f9..fcaadd8b7a5 100644 --- a/discovery/gmail-v1.json +++ b/discovery/gmail-v1.json @@ -53,7 +53,7 @@ "canonicalName": "Gmail", "description": "The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/gmail/api/", + "documentationLink": "https://developers.google.com/workspace/gmail/api/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -1106,7 +1106,7 @@ "type": "boolean" }, "labelIds": { - "description": "Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/gmail/api/guides/labels#manage_labels_on_messages_threads).", + "description": "Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads).", "location": "query", "repeated": true, "type": "string" @@ -1184,7 +1184,7 @@ ] }, "send": { - "description": "Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For example usage, see [Sending email](https://developers.google.com/gmail/api/guides/sending).", + "description": "Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For example usage, see [Sending email](https://developers.google.com/workspace/gmail/api/guides/sending).", "flatPath": "gmail/v1/users/{userId}/messages/send", "httpMethod": "POST", "id": "gmail.users.messages.send", @@ -3077,7 +3077,7 @@ } } }, - "revision": "20240527", + "revision": "20250331", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { @@ -3711,7 +3711,7 @@ "id": "LanguageSettings", "properties": { "displayLanguage": { - "description": "The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the \"Language\" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).", + "description": "The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the \"Language\" dropdown in the Gmail settings for all available options, as described in the language settings help article. For a table of sample values, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).", "type": "string" } }, @@ -3769,7 +3769,7 @@ "id": "ListDraftsResponse", "properties": { "drafts": { - "description": "List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The messages.get method can fetch additional message details.", + "description": "List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The [`messages.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/messages/get) method can fetch additional message details.", "items": { "$ref": "Draft" }, @@ -3841,7 +3841,7 @@ "id": "ListLabelsResponse", "properties": { "labels": { - "description": "List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The labels.get method can fetch additional label details.", + "description": "List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`labels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/labels/get) method can fetch additional label details.", "items": { "$ref": "Label" }, @@ -3912,7 +3912,7 @@ "type": "integer" }, "threads": { - "description": "List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the threads.get method.", + "description": "List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the [`threads.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/threads/get) method.", "items": { "$ref": "Thread" }, diff --git a/discovery/gmailpostmastertools-v1.json b/discovery/gmailpostmastertools-v1.json index d364d923f58..eabb0671b7c 100644 --- a/discovery/gmailpostmastertools-v1.json +++ b/discovery/gmailpostmastertools-v1.json @@ -14,7 +14,7 @@ "canonicalName": "Postmaster Tools", "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/gmail/postmaster", + "documentationLink": "https://developers.google.com/workspace/gmail/postmaster", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -265,7 +265,7 @@ } } }, - "revision": "20230920", + "revision": "20250325", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/discovery/gmailpostmastertools-v1beta1.json b/discovery/gmailpostmastertools-v1beta1.json index eb4f4067c66..1abc1fa45d8 100644 --- a/discovery/gmailpostmastertools-v1beta1.json +++ b/discovery/gmailpostmastertools-v1beta1.json @@ -14,7 +14,7 @@ "canonicalName": "Postmaster Tools", "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/gmail/postmaster", + "documentationLink": "https://developers.google.com/workspace/gmail/postmaster", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -265,7 +265,7 @@ } } }, - "revision": "20230920", + "revision": "20250325", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 0c4d328c3e2..6f0532bcabf 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -147,6 +147,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -5088,7 +5094,7 @@ } } }, - "revision": "20250219", + "revision": "20250409", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5931,12 +5937,12 @@ "type": "string" }, "satisfiesPzi": { - "description": "Output only. For future use.", + "description": "Output only. Whether the dataset satisfies zone isolation.", "readOnly": true, "type": "boolean" }, "satisfiesPzs": { - "description": "Output only. For future use.", + "description": "Output only. Whether the dataset satisfies zone separation.", "readOnly": true, "type": "boolean" }, diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 1a5554d1d6b..bba6ab6ad5c 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -147,6 +147,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -6011,7 +6017,7 @@ } } }, - "revision": "20250306", + "revision": "20250409", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -7075,12 +7081,12 @@ "type": "string" }, "satisfiesPzi": { - "description": "Output only. For future use.", + "description": "Output only. Whether the dataset satisfies zone isolation.", "readOnly": true, "type": "boolean" }, "satisfiesPzs": { - "description": "Output only. For future use.", + "description": "Output only. Whether the dataset satisfies zone separation.", "readOnly": true, "type": "boolean" }, diff --git a/discovery/homegraph-v1.json b/discovery/homegraph-v1.json index d84f37a132c..ee45b3729ed 100644 --- a/discovery/homegraph-v1.json +++ b/discovery/homegraph-v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20230707", + "revision": "20250410", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { @@ -472,7 +472,7 @@ "type": "object" }, "ReportStateAndNotificationRequest": { - "description": "Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, \"123\" and \"456\" in the following example). Example: ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"agentUserId\": \"1234\", \"payload\": { \"devices\": { \"states\": { \"123\": { \"on\": true }, \"456\": { \"on\": true, \"brightness\": 10 } }, } } } ```", + "description": "Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, \"123\" and \"456\" in the following example). Example: ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"agentUserId\": \"1234\", \"payload\": { \"devices\": { \"states\": { \"123\": { \"on\": true }, \"456\": { \"on\": true, \"brightness\": 10 }, }, } } } ```", "id": "ReportStateAndNotificationRequest", "properties": { "agentUserId": { diff --git a/discovery/iam-v1.json b/discovery/iam-v1.json index c32659ba187..9d002d8306c 100644 --- a/discovery/iam-v1.json +++ b/discovery/iam-v1.json @@ -1612,6 +1612,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets IAM policies for one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:getIamPolicy", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.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/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all non-deleted WorkloadIdentityPools in a project. If `show_deleted` is set to `true`, then deleted pools are also listed.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools", @@ -1687,6 +1715,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setIamPolicy": { + "description": "Sets IAM policies on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:setIamPolicy", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.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/[^/]+/workloadIdentityPools/[^/]+$", + "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 the caller's permissions on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:testIamPermissions", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.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/[^/]+/workloadIdentityPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "undelete": { "description": "Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:undelete", @@ -1718,8 +1802,509 @@ }, "resources": { "namespaces": { + "methods": { + "create": { + "description": "Creates a new WorkloadIdentityPoolNamespace in a WorkloadIdentityPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource to create the namespace in. The only supported location is `global`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+$", + "required": true, + "type": "string" + }, + "workloadIdentityPoolNamespaceId": { + "description": "Required. The ID to use for the namespace. This value must: * contain at most 63 characters * contain only lowercase alphanumeric characters or `-` * start with an alphanumeric character * end with an alphanumeric character The prefix \"gcp-\" will be reserved for future uses.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/namespaces", + "request": { + "$ref": "WorkloadIdentityPoolNamespace" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a WorkloadIdentityPoolNamespace. You can undelete a namespace for 30 days. After 30 days, deletion is permanent.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}", + "httpMethod": "DELETE", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the namespace to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an individual WorkloadIdentityPoolNamespace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the namespace to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "WorkloadIdentityPoolNamespace" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all non-deleted WorkloadIdentityPoolNamespaces in a workload identity pool. If `show_deleted` is set to `true`, then deleted namespaces are also listed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of namespaces to return. If unspecified, at most 50 namespaces are returned. The maximum value is 1000; values above are 1000 truncated to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListWorkloadIdentityPoolNamespaces` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource to list namespaces for.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Whether to return soft-deleted namespaces.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/namespaces", + "response": { + "$ref": "ListWorkloadIdentityPoolNamespacesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing WorkloadIdentityPoolNamespace in a WorkloadIdentityPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}", + "httpMethod": "PATCH", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the namespace.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "WorkloadIdentityPoolNamespace" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "undelete": { + "description": "Undeletes a WorkloadIdentityPoolNamespace, as long as it was deleted fewer than 30 days ago.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}:undelete", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.undelete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the namespace to undelete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:undelete", + "request": { + "$ref": "UndeleteWorkloadIdentityPoolNamespaceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "managedIdentities": { + "methods": { + "addAttestationRule": { + "description": "Add an AttestationRule on a WorkloadIdentityPoolManagedIdentity. The total attestation rules after addition must not exceed 50.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:addAttestationRule", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.addAttestationRule", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The resource name of the managed identity or namespace resource to add an attestation rule to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:addAttestationRule", + "request": { + "$ref": "AddAttestationRuleRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new WorkloadIdentityPoolManagedIdentity in a WorkloadIdentityPoolNamespace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource to create the manage identity in. The only supported location is `global`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + }, + "workloadIdentityPoolManagedIdentityId": { + "description": "Required. The ID to use for the managed identity. This value must: * contain at most 63 characters * contain only lowercase alphanumeric characters or `-` * start with an alphanumeric character * end with an alphanumeric character The prefix \"gcp-\" will be reserved for future uses.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/managedIdentities", + "request": { + "$ref": "WorkloadIdentityPoolManagedIdentity" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a WorkloadIdentityPoolManagedIdentity. You can undelete a managed identity for 30 days. After 30 days, deletion is permanent.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}", + "httpMethod": "DELETE", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the managed identity to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an individual WorkloadIdentityPoolManagedIdentity.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the managed identity to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "WorkloadIdentityPoolManagedIdentity" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all non-deleted WorkloadIdentityPoolManagedIdentitys in a namespace. If `show_deleted` is set to `true`, then deleted managed identites are also listed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of managed identities to return. If unspecified, at most 50 managed identities are returned. The maximum value is 1000; values above are 1000 truncated to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListWorkloadIdentityPoolManagedIdentities` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource to list managed identities for.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Whether to return soft-deleted managed identities.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/managedIdentities", + "response": { + "$ref": "ListWorkloadIdentityPoolManagedIdentitiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listAttestationRules": { + "description": "List all AttestationRule on a WorkloadIdentityPoolManagedIdentity.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:listAttestationRules", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.listAttestationRules", + "parameterOrder": [ + "resource" + ], + "parameters": { + "filter": { + "description": "Optional. A query filter. Supports the following function: * `container_ids()`: Returns only the AttestationRules under the specific container ids. The function expects a comma-delimited list with only project numbers and must use the format `projects/`. For example: `container_ids(projects/, projects/,...)`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of AttestationRules to return. If unspecified, at most 50 AttestationRules are returned. The maximum value is 100; values above 100 are truncated to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListWorkloadIdentityPoolProviderKeys` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "resource": { + "description": "Required. The resource name of the managed identity or namespace resource to list attestation rules of.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:listAttestationRules", + "response": { + "$ref": "ListAttestationRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing WorkloadIdentityPoolManagedIdentity in a WorkloadIdentityPoolNamespace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}", + "httpMethod": "PATCH", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the managed identity.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "WorkloadIdentityPoolManagedIdentity" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeAttestationRule": { + "description": "Remove an AttestationRule on a WorkloadIdentityPoolManagedIdentity.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:removeAttestationRule", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.removeAttestationRule", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The resource name of the managed identity or namespace resource to remove an attestation rule from.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:removeAttestationRule", + "request": { + "$ref": "RemoveAttestationRuleRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setAttestationRules": { + "description": "Set all AttestationRule on a WorkloadIdentityPoolManagedIdentity. A maximum of 50 AttestationRules can be set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:setAttestationRules", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.setAttestationRules", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The resource name of the managed identity or namespace resource to add an attestation rule to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setAttestationRules", + "request": { + "$ref": "SetAttestationRulesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "undelete": { + "description": "Undeletes a WorkloadIdentityPoolManagedIdentity, as long as it was deleted fewer than 30 days ago.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:undelete", + "httpMethod": "POST", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.undelete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the managed identity to undelete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:undelete", + "request": { + "$ref": "UndeleteWorkloadIdentityPoolManagedIdentityRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -2722,7 +3307,7 @@ }, "signBlob": { "deprecated": true, - "description": "**Note:** This method is deprecated. Use the [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount.", + "description": " Signs a blob using the system-managed private key for a ServiceAccount.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob", "httpMethod": "POST", "id": "iam.projects.serviceAccounts.signBlob", @@ -2751,7 +3336,7 @@ }, "signJwt": { "deprecated": true, - "description": "**Note:** This method is deprecated. Use the [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.", + "description": " Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt", "httpMethod": "POST", "id": "iam.projects.serviceAccounts.signJwt", @@ -3188,7 +3773,7 @@ } } }, - "revision": "20250213", + "revision": "20250411", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -3209,6 +3794,17 @@ }, "type": "object" }, + "AddAttestationRuleRequest": { + "description": "Request message for AddAttestationRule.", + "id": "AddAttestationRuleRequest", + "properties": { + "attestationRule": { + "$ref": "AttestationRule", + "description": "Required. The attestation rule to be added." + } + }, + "type": "object" + }, "AdminAuditData": { "description": "Audit log information specific to Cloud IAM admin APIs. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.", "id": "AdminAuditData", @@ -3220,6 +3816,17 @@ }, "type": "object" }, + "AttestationRule": { + "description": "Defines which workloads can receive an identity within a pool. When an AttestationRule is defined under a managed identity, matching workloads may receive that identity.", + "id": "AttestationRule", + "properties": { + "googleCloudResource": { + "description": "Optional. A single workload operating on Google Cloud. For example: `//compute.googleapis.com/projects/123/uid/zones/us-central1-a/instances/12345`.", + "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", @@ -3556,8 +4163,8 @@ ], "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 `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." + "Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `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 group mail addresses of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`", + "Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `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 of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`" ], "type": "string" }, @@ -3698,6 +4305,75 @@ }, "type": "object" }, + "InlineCertificateIssuanceConfig": { + "description": "Represents configuration for generating mutual TLS (mTLS) certificates for the identities within this pool.", + "id": "InlineCertificateIssuanceConfig", + "properties": { + "caPools": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * Key format: A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * Value format: A valid CA pool resource path format like: \"projects/{project}/locations/{location}/caPools/{ca_pool}\" * Region Matching: Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).", + "type": "object" + }, + "keyAlgorithm": { + "description": "Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to ECDSA_P256.", + "enum": [ + "KEY_ALGORITHM_UNSPECIFIED", + "RSA_2048", + "RSA_3072", + "RSA_4096", + "ECDSA_P256", + "ECDSA_P384" + ], + "enumDescriptions": [ + "Unspecified key algorithm. Defaults to ECDSA_P256.", + "Specifies RSA with a 2048-bit modulus.", + "Specifies RSA with a 3072-bit modulus.", + "Specifies RSA with a 4096-bit modulus.", + "Specifies ECDSA with curve P256.", + "Specifies ECDSA with curve P384." + ], + "type": "string" + }, + "lifetime": { + "description": "Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 10 hours - 30 days. If unspecified, this will be defaulted to 24 hours.", + "format": "google-duration", + "type": "string" + }, + "rotationWindowPercentage": { + "description": "Optional. Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between 10 - 80. If unspecified, this will be defaulted to 50.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InlineTrustConfig": { + "description": "Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration.", + "id": "InlineTrustConfig", + "properties": { + "additionalTrustBundles": { + "additionalProperties": { + "$ref": "TrustStore" + }, + "description": "Optional. Maps specific trust domains (e.g., \"example.com\") to their corresponding TrustStore objects, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools.", + "type": "object" + } + }, + "type": "object" + }, + "IntermediateCA": { + "description": "Intermediate CA certificates used for building the trust chain to trust anchor", + "id": "IntermediateCA", + "properties": { + "pemCertificate": { + "description": "PEM certificate of the PKI used for validation. Must only contain one ca certificate.", + "type": "string" + } + }, + "type": "object" + }, "KeyData": { "description": "Represents a public key data along with its format.", "id": "KeyData", @@ -3836,6 +4512,24 @@ }, "type": "object" }, + "ListAttestationRulesResponse": { + "description": "Response message for ListAttestationRules.", + "id": "ListAttestationRulesResponse", + "properties": { + "attestationRules": { + "description": "A list of AttestationRules.", + "items": { + "$ref": "AttestationRule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Optional. 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" + }, "ListOauthClientCredentialsResponse": { "description": "Response message for ListOauthClientCredentials.", "id": "ListOauthClientCredentialsResponse", @@ -3972,6 +4666,42 @@ }, "type": "object" }, + "ListWorkloadIdentityPoolManagedIdentitiesResponse": { + "description": "Response message for ListWorkloadIdentityPoolManagedIdentities.", + "id": "ListWorkloadIdentityPoolManagedIdentitiesResponse", + "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" + }, + "workloadIdentityPoolManagedIdentities": { + "description": "A list of managed identities.", + "items": { + "$ref": "WorkloadIdentityPoolManagedIdentity" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListWorkloadIdentityPoolNamespacesResponse": { + "description": "Response message for ListWorkloadIdentityPoolNamespaces.", + "id": "ListWorkloadIdentityPoolNamespacesResponse", + "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" + }, + "workloadIdentityPoolNamespaces": { + "description": "A list of namespaces.", + "items": { + "$ref": "WorkloadIdentityPoolNamespace" + }, + "type": "array" + } + }, + "type": "object" + }, "ListWorkloadIdentityPoolProviderKeysResponse": { "description": "Response message for ListWorkloadIdentityPoolProviderKeys.", "id": "ListWorkloadIdentityPoolProviderKeysResponse", @@ -4156,7 +4886,7 @@ "type": "array" }, "issuerUri": { - "description": "Required. The OIDC issuer URL. Must be an HTTPS endpoint.", + "description": "Required. The OIDC issuer URL. Must be an HTTPS endpoint. Used per OpenID Connect Discovery 1.0 spec to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'.", "type": "string" }, "jwksJson": { @@ -4245,6 +4975,17 @@ }, "type": "object" }, + "OwnerService": { + "description": "The Google Cloud service that owns this namespace.", + "id": "OwnerService", + "properties": { + "principalSubject": { + "description": "Required. The service agent principal subject, e.g. \"serviceAccount:service-1234@gcp-sa-gkehub.iam.gserviceaccount.com\".", + "type": "string" + } + }, + "type": "object" + }, "PatchServiceAccountRequest": { "description": "The service account patch request. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response.", "id": "PatchServiceAccountRequest", @@ -4529,6 +5270,17 @@ }, "type": "object" }, + "RemoveAttestationRuleRequest": { + "description": "Request message for RemoveAttestationRule.", + "id": "RemoveAttestationRuleRequest", + "properties": { + "attestationRule": { + "$ref": "AttestationRule", + "description": "Required. The attestation rule to be removed." + } + }, + "type": "object" + }, "Role": { "description": "A role in the Identity and Access Management API.", "id": "Role", @@ -4772,6 +5524,20 @@ }, "type": "object" }, + "SetAttestationRulesRequest": { + "description": "Request message for SetAttestationRules.", + "id": "SetAttestationRulesRequest", + "properties": { + "attestationRules": { + "description": "Required. The attestation rules to be set. At most 50 attestation rules can be set.", + "items": { + "$ref": "AttestationRule" + }, + "type": "array" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -4903,6 +5669,38 @@ }, "type": "object" }, + "TrustAnchor": { + "description": "Represents a root of trust.", + "id": "TrustAnchor", + "properties": { + "pemCertificate": { + "description": "PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).", + "type": "string" + } + }, + "type": "object" + }, + "TrustStore": { + "description": "Trust store that contains trust anchors and optional intermediate CAs used in PKI to build trust chain and verify client's identity.", + "id": "TrustStore", + "properties": { + "intermediateCas": { + "description": "Optional. Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: * Intermediate CAs are only supported when configuring x509 federation.", + "items": { + "$ref": "IntermediateCA" + }, + "type": "array" + }, + "trustAnchors": { + "description": "Required. List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here.", + "items": { + "$ref": "TrustAnchor" + }, + "type": "array" + } + }, + "type": "object" + }, "UndeleteOauthClientRequest": { "description": "Request message for UndeleteOauthClient.", "id": "UndeleteOauthClientRequest", @@ -4961,6 +5759,18 @@ "properties": {}, "type": "object" }, + "UndeleteWorkloadIdentityPoolManagedIdentityRequest": { + "description": "Request message for UndeleteWorkloadIdentityPoolManagedIdentity.", + "id": "UndeleteWorkloadIdentityPoolManagedIdentityRequest", + "properties": {}, + "type": "object" + }, + "UndeleteWorkloadIdentityPoolNamespaceRequest": { + "description": "Request message for UndeleteWorkloadIdentityPoolNamespace.", + "id": "UndeleteWorkloadIdentityPoolNamespaceRequest", + "properties": {}, + "type": "object" + }, "UndeleteWorkloadIdentityPoolProviderKeyRequest": { "description": "Request message for UndeleteWorkloadIdentityPoolProviderKey.", "id": "UndeleteWorkloadIdentityPoolProviderKeyRequest", @@ -5185,6 +5995,28 @@ "readOnly": true, "type": "string" }, + "inlineCertificateIssuanceConfig": { + "$ref": "InlineCertificateIssuanceConfig", + "description": "Optional. Defines the Certificate Authority (CA) pool resources and configurations required for issuance and rotation of mTLS workload certificates." + }, + "inlineTrustConfig": { + "$ref": "InlineTrustConfig", + "description": "Optional. Represents config to add additional trusted trust domains." + }, + "mode": { + "description": "Immutable. The mode the pool is operating in.", + "enum": [ + "MODE_UNSPECIFIED", + "FEDERATION_ONLY", + "TRUST_DOMAIN" + ], + "enumDescriptions": [ + "State unspecified. New pools should not use this mode. Pools with an unspecified mode will operate as if they are in FEDERATION_ONLY mode.", + "FEDERATION_ONLY mode pools can only be used for federating external workload identities into Google Cloud. Unless otherwise noted, no structure or format constraints are applied to workload identities in a FEDERATION_ONLY mode pool, and you may not create any resources within the pool besides providers.", + "TRUST_DOMAIN mode pools can be used to assign identities to either external workloads or those hosted on Google Cloud. All identities within a TRUST_DOMAIN mode pool must consist of a single namespace and individual workload identifier. The subject identifier for all identities must conform to the following format: `ns//sa/` WorkloadIdentityPoolProviders cannot be created within TRUST_DOMAIN mode pools." + ], + "type": "string" + }, "name": { "description": "Output only. The resource name of the pool.", "readOnly": true, @@ -5208,6 +6040,93 @@ }, "type": "object" }, + "WorkloadIdentityPoolManagedIdentity": { + "description": "Represents a managed identity for a workload identity pool namespace.", + "id": "WorkloadIdentityPoolManagedIdentity", + "properties": { + "description": { + "description": "A description of the managed identity. Cannot exceed 256 characters.", + "type": "string" + }, + "disabled": { + "description": "Whether the managed identity is disabled. If disabled, credentials may no longer be issued for the identity, however existing credentials will still be accepted until they expire.", + "type": "boolean" + }, + "expireTime": { + "description": "Output only. Time after which the managed identity will be permanently purged and cannot be recovered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the managed identity.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the managed identity.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "DELETED" + ], + "enumDescriptions": [ + "State unspecified.", + "The managed identity is active.", + "The managed identity is soft-deleted. Soft-deleted managed identities are permanently deleted after approximately 30 days. You can restore a soft-deleted managed identity using UndeleteWorkloadIdentityPoolManagedIdentity. You cannot reuse the ID of a soft-deleted managed identity until it is permanently deleted." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "WorkloadIdentityPoolNamespace": { + "description": "Represents a namespace for a workload identity pool. Namespaces are used to segment identities within the pool.", + "id": "WorkloadIdentityPoolNamespace", + "properties": { + "description": { + "description": "A description of the namespace. Cannot exceed 256 characters.", + "type": "string" + }, + "disabled": { + "description": "Whether the namespace is disabled. If disabled, credentials may no longer be issued for identities within this namespace, however existing credentials will still be accepted until they expire.", + "type": "boolean" + }, + "expireTime": { + "description": "Output only. Time after which the namespace will be permanently purged and cannot be recovered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the namespace.", + "readOnly": true, + "type": "string" + }, + "ownerService": { + "$ref": "OwnerService", + "description": "Output only. The Google Cloud service that owns this namespace.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the namespace.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "DELETED" + ], + "enumDescriptions": [ + "State unspecified.", + "The namespace is active.", + "The namespace is soft-deleted. Soft-deleted namespaces are permanently deleted after approximately 30 days. You can restore a soft-deleted namespace using UndeleteWorkloadIdentityPoolNamespace. You cannot reuse the ID of a soft-deleted namespace until it is permanently deleted." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "WorkloadIdentityPoolOperationMetadata": { "description": "Metadata for long-running WorkloadIdentityPool operations.", "id": "WorkloadIdentityPoolOperationMetadata", @@ -5278,6 +6197,10 @@ ], "readOnly": true, "type": "string" + }, + "x509": { + "$ref": "X509", + "description": "An X.509-type identity provider." } }, "type": "object" @@ -5330,6 +6253,17 @@ } }, "type": "object" + }, + "X509": { + "description": "An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA.", + "id": "X509", + "properties": { + "trustStore": { + "$ref": "TrustStore", + "description": "Required. A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported." + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/iamcredentials-v1.json b/discovery/iamcredentials-v1.json index b2633247179..1949c777bf2 100644 --- a/discovery/iamcredentials-v1.json +++ b/discovery/iamcredentials-v1.json @@ -15,6 +15,13 @@ "description": "Creates short-lived credentials for impersonating IAM service accounts. Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://iamcredentials.us-east7.rep.googleapis.com/", + "location": "us-east7" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -105,8 +112,68 @@ }, "protocol": "rest", "resources": { + "locations": { + "resources": { + "workforcePools": { + "methods": { + "getAllowedLocations": { + "description": "Returns the trust boundary info for a given workforce pool.", + "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/allowedLocations", + "httpMethod": "GET", + "id": "iamcredentials.locations.workforcePools.getAllowedLocations", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of workforce pool.", + "location": "path", + "pattern": "^locations/[^/]+/workforcePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/allowedLocations", + "response": { + "$ref": "WorkforcePoolAllowedLocations" + } + } + } + } + } + }, "projects": { "resources": { + "locations": { + "resources": { + "workloadIdentityPools": { + "methods": { + "getAllowedLocations": { + "description": "Returns the trust boundary info for a given workload identity pool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/allowedLocations", + "httpMethod": "GET", + "id": "iamcredentials.projects.locations.workloadIdentityPools.getAllowedLocations", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of workload identity pool.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/allowedLocations", + "response": { + "$ref": "WorkloadIdentityPoolAllowedLocations" + } + } + } + } + } + }, "serviceAccounts": { "methods": { "generateAccessToken": { @@ -248,7 +315,7 @@ } } }, - "revision": "20241024", + "revision": "20250417", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { @@ -308,6 +375,10 @@ "includeEmail": { "description": "Include the service account email in the token. If set to `true`, the token will contain `email` and `email_verified` claims.", "type": "boolean" + }, + "organizationNumberIncluded": { + "description": "Include the organization number of the service account in the token. If set to `true`, the token will contain a `google.organization_number` claim. The value of the claim will be `null` if the service account isn't associated with an organization.", + "type": "boolean" } }, "type": "object" @@ -316,7 +387,7 @@ "id": "GenerateIdTokenResponse", "properties": { "token": { - "description": "The OpenId Connect ID token.", + "description": "The OpenId Connect ID token. The token is a JSON Web Token (JWT) that contains a payload with claims. See the [JSON Web Token spec](https://tools.ietf.org/html/rfc7519) for more information. Here is an example of a decoded JWT payload: ``` { \"iss\": \"https://accounts.google.com\", \"iat\": 1496953245, \"exp\": 1496953245, \"aud\": \"https://www.example.com\", \"sub\": \"107517467455664443765\", \"azp\": \"107517467455664443765\", \"email\": \"my-iam-account@my-project.iam.gserviceaccount.com\", \"email_verified\": true, \"google\": { \"organization_number\": 123456 } } ```", "type": "string" } }, @@ -405,6 +476,46 @@ } }, "type": "object" + }, + "WorkforcePoolAllowedLocations": { + "description": "Represents a list of allowed locations for given workforce pool.", + "id": "WorkforcePoolAllowedLocations", + "properties": { + "encodedLocations": { + "description": "Output only. The hex encoded bitmap of the trust boundary locations", + "readOnly": true, + "type": "string" + }, + "locations": { + "description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "WorkloadIdentityPoolAllowedLocations": { + "description": "Represents a list of allowed locations for given workload identity pool.", + "id": "WorkloadIdentityPoolAllowedLocations", + "properties": { + "encodedLocations": { + "description": "Output only. The hex encoded bitmap of the trust boundary locations", + "readOnly": true, + "type": "string" + }, + "locations": { + "description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/iap-v1.json b/discovery/iap-v1.json index a2b71d18b66..8a24cdc6f89 100644 --- a/discovery/iap-v1.json +++ b/discovery/iap-v1.json @@ -682,7 +682,7 @@ } } }, - "revision": "20241202", + "revision": "20250407", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { @@ -1243,7 +1243,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The proto or JSON formatted expected next state of the resource, wrapped in a google.protobuf.Any proto, against which the policy rules are evaluated. Services not integrated with custom org policy can omit this field. Services integrated with custom org policy must populate this field for all requests where the API call changes the state of the resource. Custom org policy backend uses these attributes to enforce custom org policies. For create operations, GCP service is expected to pass resource from customer request as is. For update/patch operations, GCP service is expected to compute the next state with the patch provided by the user. See go/custom-constraints-org-policy-integration-guide for additional details.", + "description": "The proto or JSON formatted expected next state of the resource, wrapped in a google.protobuf.Any proto, against which the policy rules are evaluated. Services not integrated with custom org policy can omit this field. Services integrated with custom org policy must populate this field for all requests where the API call changes the state of the resource. Custom org policy backend uses these attributes to enforce custom org policies. For create operations, GCP service is expected to pass resource from customer request as is. For update/patch operations, GCP service is expected to compute the next state with the patch provided by the user. See go/federated-custom-org-policy-integration-guide for additional details.", "type": "object" }, "labels": { diff --git a/discovery/ids-v1.json b/discovery/ids-v1.json index 96f0969d92f..8603ea0c051 100644 --- a/discovery/ids-v1.json +++ b/discovery/ids-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -487,7 +493,7 @@ } } }, - "revision": "20250304", + "revision": "20250320", "rootUrl": "https://ids.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/index.json b/discovery/index.json index df4b287ea3e..95213cbf9bf 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -109,7 +109,7 @@ { "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1", - "documentationLink": "https://developers.google.com/admin-sdk/", + "documentationLink": "https://developers.google.com/workspace/admin/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -124,7 +124,7 @@ { "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=directory_v1", - "documentationLink": "https://developers.google.com/admin-sdk/", + "documentationLink": "https://developers.google.com/workspace/admin/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -139,7 +139,7 @@ { "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=reports_v1", - "documentationLink": "https://developers.google.com/admin-sdk/", + "documentationLink": "https://developers.google.com/workspace/admin/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -289,7 +289,7 @@ { "description": "Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.", "discoveryRestUrl": "https://alertcenter.googleapis.com/$discovery/rest?version=v1beta1", - "documentationLink": "https://developers.google.com/admin-sdk/alertcenter/", + "documentationLink": "https://developers.google.com/workspace/admin/alertcenter/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -691,7 +691,7 @@ "version": "v1alpha1" }, { - "description": "Places Insights API.", + "description": "Places Aggregate API.", "discoveryRestUrl": "https://areainsights.googleapis.com/$discovery/rest?version=v1", "documentationLink": "https://g3doc.corp.google.com/geo/platform/area_insights/README.md?cl=head", "icons": { @@ -702,7 +702,7 @@ "kind": "discovery#directoryItem", "name": "areainsights", "preferred": true, - "title": "Places Insights API", + "title": "Places Aggregate API", "version": "v1" }, { @@ -1263,7 +1263,7 @@ { "description": "Manages classes, rosters, and invitations in Google Classroom.", "discoveryRestUrl": "https://classroom.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/classroom", + "documentationLink": "https://developers.google.com/workspace/classroom", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -1713,7 +1713,7 @@ { "description": "Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.", "discoveryRestUrl": "https://cloudsearch.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/cloud-search/docs/guides/", + "documentationLink": "https://developers.google.com/workspace/cloud-search/docs/guides/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -2766,7 +2766,7 @@ { "description": "Reads and writes Google Docs documents.", "discoveryRestUrl": "https://docs.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/docs/", + "documentationLink": "https://developers.google.com/workspace/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" @@ -2918,7 +2918,7 @@ { "description": "Provides a historical view of activity in Google Drive.", "discoveryRestUrl": "https://driveactivity.googleapis.com/$discovery/rest?version=v2", - "documentationLink": "https://developers.google.com/drive/activity/", + "documentationLink": "https://developers.google.com/workspace/drive/activity/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -2933,7 +2933,7 @@ { "description": "An API for managing Drive Labels", "discoveryRestUrl": "https://drivelabels.googleapis.com/$discovery/rest?version=v2beta", - "documentationLink": "https://developers.google.com/drive/labels", + "documentationLink": "https://developers.google.com/workspace/drive/labels", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -2948,7 +2948,7 @@ { "description": "An API for managing Drive Labels", "discoveryRestUrl": "https://drivelabels.googleapis.com/$discovery/rest?version=v2", - "documentationLink": "https://developers.google.com/drive/labels", + "documentationLink": "https://developers.google.com/workspace/drive/labels", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -3166,10 +3166,25 @@ "id": "firebasedataconnect:v1beta", "kind": "discovery#directoryItem", "name": "firebasedataconnect", - "preferred": true, + "preferred": false, "title": "Firebase Data Connect API", "version": "v1beta" }, + { + "description": "Firebase Data Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered by Cloud SQL. The REST API lets developers manage the connections to their database, change the schema of their database, and query the database.", + "discoveryRestUrl": "https://firebasedataconnect.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/data-connect", + "icons": { + "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": "firebasedataconnect:v1", + "kind": "discovery#directoryItem", + "name": "firebasedataconnect", + "preferred": true, + "title": "Firebase Data Connect API", + "version": "v1" + }, { "description": "Programmatically creates and manages Firebase Dynamic Links.", "discoveryRestUrl": "https://firebasedynamiclinks.googleapis.com/$discovery/rest?version=v1", @@ -3377,7 +3392,7 @@ "kind": "discovery#directoryItem", "name": "games", "preferred": true, - "title": "Google Play Game Services", + "title": "Google Play Games Services API", "version": "v1" }, { @@ -3392,7 +3407,7 @@ "kind": "discovery#directoryItem", "name": "gamesConfiguration", "preferred": true, - "title": "Google Play Game Services Publishing API", + "title": "Google Play Games Services Publishing API", "version": "v1configuration" }, { @@ -3407,7 +3422,7 @@ "kind": "discovery#directoryItem", "name": "gamesManagement", "preferred": true, - "title": "Google Play Game Management", + "title": "Google Play Games Services Management API", "version": "v1management" }, { @@ -3548,7 +3563,7 @@ { "description": "The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.", "discoveryRestUrl": "https://gmail.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/gmail/api/", + "documentationLink": "https://developers.google.com/workspace/gmail/api/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -3563,7 +3578,7 @@ { "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryRestUrl": "https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1beta1", - "documentationLink": "https://developers.google.com/gmail/postmaster", + "documentationLink": "https://developers.google.com/workspace/gmail/postmaster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -3578,7 +3593,7 @@ { "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryRestUrl": "https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/gmail/postmaster", + "documentationLink": "https://developers.google.com/workspace/gmail/postmaster", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -3893,7 +3908,7 @@ { "description": "The Google Keep API is used in an enterprise environment to manage Google Keep content and resolve issues identified by cloud security software.", "discoveryRestUrl": "https://keep.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/keep/api", + "documentationLink": "https://developers.google.com/workspace/keep/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -3998,7 +4013,7 @@ { "description": "The Google Enterprise License Manager API lets you manage Google Workspace and related licenses for all users of a customer that you manage.", "discoveryRestUrl": "https://licensing.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/admin-sdk/licensing/", + "documentationLink": "https://developers.google.com/workspace/admin/licensing/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -4163,7 +4178,7 @@ { "description": "Create and manage meetings in Google Meet.", "discoveryRestUrl": "https://meet.googleapis.com/$discovery/rest?version=v2", - "documentationLink": "https://developers.google.com/meet/api", + "documentationLink": "https://developers.google.com/workspace/meet/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -4836,6 +4851,21 @@ "title": "Google OAuth2 API", "version": "v2" }, + { + "description": "", + "discoveryRestUrl": "https://observability.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/stackdriver/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": "observability:v1", + "kind": "discovery#directoryItem", + "name": "observability", + "preferred": true, + "title": "Observability API", + "version": "v1" + }, { "description": "A service to scan container images for vulnerabilities.", "discoveryRestUrl": "https://ondemandscanning.googleapis.com/$discovery/rest?version=v1beta1", @@ -4952,10 +4982,25 @@ "id": "osconfig:v1", "kind": "discovery#directoryItem", "name": "osconfig", - "preferred": true, + "preferred": false, "title": "OS Config API", "version": "v1" }, + { + "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", + "discoveryRestUrl": "https://osconfig.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "osconfig:v2", + "kind": "discovery#directoryItem", + "name": "osconfig", + "preferred": true, + "title": "OS Config API", + "version": "v2" + }, { "description": "You can use OS Login to manage access to your VM instances using IAM roles.", "discoveryRestUrl": "https://oslogin.googleapis.com/$discovery/rest?version=v1alpha", @@ -6069,7 +6114,7 @@ { "description": "Reads and writes Google Sheets.", "discoveryRestUrl": "https://sheets.googleapis.com/$discovery/rest?version=v4", - "documentationLink": "https://developers.google.com/sheets/", + "documentationLink": "https://developers.google.com/workspace/sheets/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -6099,7 +6144,7 @@ { "description": "Reads and writes Google Slides presentations.", "discoveryRestUrl": "https://slides.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/slides/", + "documentationLink": "https://developers.google.com/workspace/slides/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -6231,6 +6276,21 @@ "title": "Cloud Storage API", "version": "v1" }, + { + "description": "", + "discoveryRestUrl": "https://storagebatchoperations.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/storage/docs/batch-operations/overview", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "storagebatchoperations:v1", + "kind": "discovery#directoryItem", + "name": "storagebatchoperations", + "preferred": true, + "title": "Storage Batch Operations API", + "version": "v1" + }, { "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.", "discoveryRestUrl": "https://storagetransfer.googleapis.com/$discovery/rest?version=v1", diff --git a/discovery/integrations-v1.json b/discovery/integrations-v1.json index 8847e6c307d..3e188796a27 100644 --- a/discovery/integrations-v1.json +++ b/discovery/integrations-v1.json @@ -824,6 +824,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "toggleHttp": { + "description": "Enable/Disable http call for provisioned client", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:toggleHttp", + "httpMethod": "POST", + "id": "integrations.projects.locations.clients.toggleHttp", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Required: The ID of the GCP Project to be provisioned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/clients:toggleHttp", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaToggleHttpRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1090,11 +1118,6 @@ "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", @@ -1206,6 +1229,11 @@ "parent" ], "parameters": { + "enableNaturalLanguageQueryUnderstanding": { + "description": "Optional. Whether to enable natural language query understanding.", + "location": "query", + "type": "boolean" + }, "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", @@ -4546,7 +4574,7 @@ } } }, - "revision": "20250310", + "revision": "20250423", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -9883,7 +9911,7 @@ "type": "object" }, "GoogleCloudConnectorsV1EventingConfig": { - "description": "Eventing Configuration of a connection", + "description": "Eventing Configuration of a connection next: 18", "id": "GoogleCloudConnectorsV1EventingConfig", "properties": { "additionalVariables": { @@ -9928,6 +9956,10 @@ "registrationDestinationConfig": { "$ref": "GoogleCloudConnectorsV1DestinationConfig", "description": "Optional. Registration endpoint for auto registration." + }, + "sslConfig": { + "$ref": "GoogleCloudConnectorsV1SslConfig", + "description": "Optional. Ssl config of a connection" } }, "type": "object" @@ -10526,11 +10558,12 @@ "type": "string" }, "reason": { - "description": "The reason / details of the current status.", + "description": "Output only. The reason / details of the current status.", + "readOnly": true, "type": "string" }, "state": { - "description": "The status of the auth config.", + "description": "Output only. The status of the auth config.", "enum": [ "STATE_UNSPECIFIED", "VALID", @@ -10549,6 +10582,7 @@ "Auth config unauthorized.", "Auth config not supported." ], + "readOnly": true, "type": "string" }, "updateTime": { @@ -10754,6 +10788,10 @@ "description": "Description of what the client is used for", "type": "string" }, + "enableHttpCall": { + "description": "Optional. Indicates the client enables making HTTP call.", + "type": "boolean" + }, "enableInternalIp": { "description": "Optional. Indicates the client enables internal IP feature, this is applicable for internal clients only.", "type": "boolean" @@ -10960,6 +10998,20 @@ "description": "The function region of CF to be created", "type": "string" }, + "gcfApiVersion": { + "description": "Optional. The api version of CF to be created", + "enum": [ + "GCF_API_VERSION_UNSPECIFIED", + "API_VERSION_V1", + "API_VERSION_V2" + ], + "enumDescriptions": [ + "Unspecified.", + "V1 API version.", + "V2 API version." + ], + "type": "string" + }, "projectId": { "description": "Indicates the id of the GCP project that the function will be created in.", "type": "string" @@ -13111,6 +13163,10 @@ "description": "Optional. Indicates if sample workflow should be created along with provisioning", "type": "boolean" }, + "enableHttpCall": { + "description": "Optional. Indicates if the client should be allowed to make HTTP calls.", + "type": "boolean" + }, "provisionGmek": { "deprecated": true, "description": "Optional. Deprecated. Indicates provision with GMEK or CMEK. This field is deprecated and the provision would always be GMEK if cloud_kms_config is not present in the request.", @@ -13493,11 +13549,13 @@ "type": "string" }, "isActive": { - "description": "Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.", + "description": "Output only. Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.", + "readOnly": true, "type": "boolean" }, "lastReplayId": { - "description": "Last sfdc messsage replay id for channel", + "description": "Output only. Last sfdc messsage replay id for channel", + "readOnly": true, "type": "string" }, "name": { @@ -13549,7 +13607,7 @@ "type": "string" }, "serviceAuthority": { - "description": "URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).", + "description": "Optional. URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).", "type": "string" }, "sfdcOrgId": { @@ -14337,6 +14395,17 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaToggleHttpRequest": { + "description": "Request to enable/disable http call for a provisioned client", + "id": "GoogleCloudIntegrationsV1alphaToggleHttpRequest", + "properties": { + "enableHttpCall": { + "description": "Required. REQUIRED: True if http call feature should be turned on for this region", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaTriggerConfig": { "description": "Configuration detail of a trigger.", "id": "GoogleCloudIntegrationsV1alphaTriggerConfig", diff --git a/discovery/jobs-v3.json b/discovery/jobs-v3.json index 53a289149ef..c0bb499f723 100644 --- a/discovery/jobs-v3.json +++ b/discovery/jobs-v3.json @@ -652,7 +652,7 @@ } } }, - "revision": "20241217", + "revision": "20250326", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -2313,18 +2313,18 @@ "type": "object" }, "PostalAddress": { - "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", + "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 or 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": "PostalAddress", "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).", + "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 or 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). In 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.", + "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. 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": { @@ -2332,7 +2332,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -2340,7 +2340,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -2360,11 +2360,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/jobs-v3p1beta1.json b/discovery/jobs-v3p1beta1.json index 70a8ecc9460..02a21b088d0 100644 --- a/discovery/jobs-v3p1beta1.json +++ b/discovery/jobs-v3p1beta1.json @@ -682,7 +682,7 @@ } } }, - "revision": "20241219", + "revision": "20250326", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -2452,18 +2452,18 @@ "type": "object" }, "PostalAddress": { - "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", + "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 or 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": "PostalAddress", "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).", + "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 or 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). In 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.", + "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. 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": { @@ -2471,7 +2471,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -2479,7 +2479,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -2499,11 +2499,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/jobs-v4.json b/discovery/jobs-v4.json index ff9adb43f53..66a070e637e 100644 --- a/discovery/jobs-v4.json +++ b/discovery/jobs-v4.json @@ -903,7 +903,7 @@ } } }, - "revision": "20241217", + "revision": "20250326", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -1896,7 +1896,7 @@ ], "enumDescriptions": [ "Default value.", - "The resource is only visible to the GCP account who owns it.", + "The resource is only visible to the Google Cloud account who owns it.", "The resource is visible to the owner and may be visible to other applications and processes at Google.", "The resource is visible to the owner and may be visible to all other API clients." ], @@ -2500,18 +2500,18 @@ "type": "object" }, "PostalAddress": { - "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", + "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 or 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": "PostalAddress", "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).", + "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 or 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). In 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.", + "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. 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": { @@ -2519,7 +2519,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -2527,7 +2527,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -2547,11 +2547,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/keep-v1.json b/discovery/keep-v1.json index 05a86882c5b..da7aeb478de 100644 --- a/discovery/keep-v1.json +++ b/discovery/keep-v1.json @@ -17,7 +17,7 @@ "canonicalName": "Keep", "description": "The Google Keep API is used in an enterprise environment to manage Google Keep content and resolve issues identified by cloud security software.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/keep/api", + "documentationLink": "https://developers.google.com/workspace/keep/api", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -314,7 +314,7 @@ } } }, - "revision": "20220322", + "revision": "20250318", "rootUrl": "https://keep.googleapis.com/", "schemas": { "Attachment": { diff --git a/discovery/language-v1.json b/discovery/language-v1.json index 9c05a45b031..841164fdbec 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250309", + "revision": "20250420", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -690,6 +690,7 @@ "UNKNOWN_CPU_TYPE", "A2", "A3", + "A4", "C2", "C2D", "CUSTOM", @@ -707,6 +708,7 @@ "", "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "COMPUTE_OPTIMIZED", "", "", @@ -763,6 +765,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1054,6 +1057,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1429,6 +1433,7 @@ "UNKNOWN_GPU_TYPE", "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", + "NVIDIA_B200", "NVIDIA_TESLA_K80", "NVIDIA_L4", "NVIDIA_TESLA_P100", @@ -1436,6 +1441,7 @@ "NVIDIA_TESLA_T4", "NVIDIA_TESLA_V100", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB" ], "enumDescriptions": [ @@ -1449,6 +1455,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -1494,6 +1502,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1785,6 +1794,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2182,6 +2192,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2473,6 +2484,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2488,6 +2500,7 @@ "UNKNOWN_RAM_TYPE", "A2", "A3", + "A4", "C2", "C2D", "CUSTOM", @@ -2505,6 +2518,7 @@ "", "", "", + "", "COMPUTE_OPTIMIZED", "", "", @@ -3655,6 +3669,7 @@ "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", + "NVIDIA_B200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3673,6 +3688,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H100 80Gb GPU.", "Nvidia H200 141Gb GPU.", + "Nvidia B200 GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index 2ac1904ec00..22fb3debd12 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250309", + "revision": "20250420", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -690,6 +690,7 @@ "UNKNOWN_CPU_TYPE", "A2", "A3", + "A4", "C2", "C2D", "CUSTOM", @@ -707,6 +708,7 @@ "", "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "COMPUTE_OPTIMIZED", "", "", @@ -763,6 +765,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1054,6 +1057,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1447,6 +1451,7 @@ "UNKNOWN_GPU_TYPE", "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", + "NVIDIA_B200", "NVIDIA_TESLA_K80", "NVIDIA_L4", "NVIDIA_TESLA_P100", @@ -1454,6 +1459,7 @@ "NVIDIA_TESLA_T4", "NVIDIA_TESLA_V100", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB" ], "enumDescriptions": [ @@ -1467,6 +1473,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -1512,6 +1520,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1803,6 +1812,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2200,6 +2210,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2491,6 +2502,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2506,6 +2518,7 @@ "UNKNOWN_RAM_TYPE", "A2", "A3", + "A4", "C2", "C2D", "CUSTOM", @@ -2523,6 +2536,7 @@ "", "", "", + "", "COMPUTE_OPTIMIZED", "", "", @@ -3673,6 +3687,7 @@ "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", + "NVIDIA_B200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3691,6 +3706,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H100 80Gb GPU.", "Nvidia H200 141Gb GPU.", + "Nvidia B200 GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v2.json b/discovery/language-v2.json index 6140066c3eb..04c4d6d850a 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20250309", + "revision": "20250420", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -515,6 +515,7 @@ "UNKNOWN_CPU_TYPE", "A2", "A3", + "A4", "C2", "C2D", "CUSTOM", @@ -532,6 +533,7 @@ "", "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "COMPUTE_OPTIMIZED", "", "", @@ -588,6 +590,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -879,6 +882,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1068,6 +1072,7 @@ "UNKNOWN_GPU_TYPE", "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", + "NVIDIA_B200", "NVIDIA_TESLA_K80", "NVIDIA_L4", "NVIDIA_TESLA_P100", @@ -1075,6 +1080,7 @@ "NVIDIA_TESLA_T4", "NVIDIA_TESLA_V100", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB" ], "enumDescriptions": [ @@ -1088,6 +1094,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -1133,6 +1141,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1424,6 +1433,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1576,6 +1586,7 @@ "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", + "A4_HIGHGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1867,6 +1878,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1882,6 +1894,7 @@ "UNKNOWN_RAM_TYPE", "A2", "A3", + "A4", "C2", "C2D", "CUSTOM", @@ -1899,6 +1912,7 @@ "", "", "", + "", "COMPUTE_OPTIMIZED", "", "", @@ -3026,6 +3040,7 @@ "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", + "NVIDIA_B200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3044,6 +3059,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H100 80Gb GPU.", "Nvidia H200 141Gb GPU.", + "Nvidia B200 GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/licensing-v1.json b/discovery/licensing-v1.json index bf7fa2898a9..5805ab76fd1 100644 --- a/discovery/licensing-v1.json +++ b/discovery/licensing-v1.json @@ -13,7 +13,7 @@ "batchPath": "batch", "description": "The Google Enterprise License Manager API lets you manage Google Workspace and related licenses for all users of a customer that you manage.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/admin-sdk/licensing/", + "documentationLink": "https://developers.google.com/workspace/admin/licensing/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -400,7 +400,7 @@ } } }, - "revision": "20220502", + "revision": "20250419", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/lifesciences-v2beta.json b/discovery/lifesciences-v2beta.json index 1e2d8b62ba9..0395aa46750 100644 --- a/discovery/lifesciences-v2beta.json +++ b/discovery/lifesciences-v2beta.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -312,7 +318,7 @@ } } }, - "revision": "20240329", + "revision": "20250411", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 8072e267211..97a8cf3b090 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -459,6 +459,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -777,7 +783,7 @@ "type": "string" }, "parent": { - "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, @@ -2285,6 +2291,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2603,7 +2615,7 @@ "type": "string" }, "parent": { - "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, @@ -3866,6 +3878,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -4184,7 +4202,7 @@ "type": "string" }, "parent": { - "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", "location": "path", "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, @@ -5103,6 +5121,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -5421,7 +5445,7 @@ "type": "string" }, "parent": { - "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, @@ -6905,6 +6929,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -7223,7 +7253,7 @@ "type": "string" }, "parent": { - "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", "required": true, @@ -8922,7 +8952,7 @@ } } }, - "revision": "20250307", + "revision": "20250411", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -9287,7 +9317,7 @@ "type": "string" }, "parent": { - "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" \"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "description": "Required. The full resource name of the bucket to create a link for. \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", "type": "string" } }, diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index b761fc417ab..fdc18a9f849 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -420,6 +426,159 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "restore": { + "description": "Restore Looker instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore", + "httpMethod": "POST", + "id": "looker.projects.locations.instances.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Instance being restored Format: projects/{project}/locations/{location}/instances/{instance}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restore", + "request": { + "$ref": "RestoreInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "backups": { + "methods": { + "create": { + "description": "Backup Looker instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups", + "httpMethod": "POST", + "id": "looker.projects.locations.instances.backups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "request": { + "$ref": "InstanceBackup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}", + "httpMethod": "DELETE", + "id": "looker.projects.locations.instances.backups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}", + "httpMethod": "GET", + "id": "looker.projects.locations.instances.backups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance}/backups/{backup}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "InstanceBackup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List backups of Looker instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups", + "httpMethod": "GET", + "id": "looker.projects.locations.instances.backups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderBy": { + "description": "Sort results. Default order is \"create_time desc\". Other supported fields are \"state\" and \"expire_time\". https://google.aip.dev/132#ordering", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of instances to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous ListInstances request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: projects/{project}/locations/{location}/instances/{instance}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "response": { + "$ref": "ListInstanceBackupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -551,7 +710,7 @@ } } }, - "revision": "20250305", + "revision": "20250414", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -971,6 +1130,78 @@ }, "type": "object" }, + "InstanceBackup": { + "description": "The details of a backup resource.", + "id": "InstanceBackup", + "properties": { + "createTime": { + "description": "Output only. The time when the backup was started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "encryptionConfig": { + "$ref": "EncryptionConfig", + "description": "Output only. Current status of the CMEK encryption", + "readOnly": true + }, + "expireTime": { + "description": "Output only. The time when the backup will be deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. The relative resource name of the backup, in the following form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}/backups/{backup}`", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the backup.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "DELETING", + "ACTIVE", + "FAILED" + ], + "enumDescriptions": [ + "The state of the backup is unknown.", + "The backup is being created.", + "The backup is being deleted.", + "The backup is active and ready to use.", + "The backup failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListInstanceBackupsResponse": { + "description": "Response from listing Looker instance backups.", + "id": "ListInstanceBackupsResponse", + "properties": { + "instanceBackups": { + "description": "The list of instances matching the request filters, up to the requested `page_size`.", + "items": { + "$ref": "InstanceBackup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If provided, a page token that can look up the next `page_size` results. If empty, the results list is exhausted.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "Response from ListInstances.", "id": "ListInstancesResponse", @@ -1237,6 +1468,17 @@ "properties": {}, "type": "object" }, + "RestoreInstanceRequest": { + "description": "Request options for restoring an instance", + "id": "RestoreInstanceRequest", + "properties": { + "backup": { + "description": "Required. Backup being used to restore the instance Format: projects/{project}/locations/{location}/instances/{instance}/backups/{backup}", + "type": "string" + } + }, + "type": "object" + }, "ServiceAttachment": { "description": "Service attachment configuration.", "id": "ServiceAttachment", diff --git a/discovery/managedkafka-v1.json b/discovery/managedkafka-v1.json index 1cbec11182b..e7e17f4a980 100644 --- a/discovery/managedkafka-v1.json +++ b/discovery/managedkafka-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -359,6 +365,219 @@ } }, "resources": { + "acls": { + "methods": { + "addAclEntry": { + "description": "Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}:addAclEntry", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.clusters.acls.addAclEntry", + "parameterOrder": [ + "acl" + ], + "parameters": { + "acl": { + "description": "Required. The name of the acl to add the acl entry to. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+acl}:addAclEntry", + "request": { + "$ref": "AclEntry" + }, + "response": { + "$ref": "AddAclEntryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new acl in the given project, location, and cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.clusters.acls.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "aclId": { + "description": "Required. The ID to use for the acl, which will become the final component of the acl's name. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name}` `consumerGroup/{resource_name}` `transactionalId/{resource_name}` For acls on all resources that match a prefix: `topicPrefixed/{resource_name}` `consumerGroupPrefixed/{resource_name}` `transactionalIdPrefixed/{resource_name}` For acls on all resources of a given type (i.e. the wildcard literal \"*\"): `allTopics` (represents `topic/*`) `allConsumerGroups` (represents `consumerGroup/*`) `allTransactionalIds` (represents `transactionalId/*`)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent cluster in which to create the acl. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/acls", + "request": { + "$ref": "Acl" + }, + "response": { + "$ref": "Acl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an acl.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.clusters.acls.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the acl to delete. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$", + "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 acl.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.acls.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the acl to return. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Acl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the acls in a given cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.acls.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of acls to return. The service may return fewer than this value. If unset or zero, all acls for the parent is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListAcls` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAcls` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent cluster whose acls 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}/acls", + "response": { + "$ref": "ListAclsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the properties of a single acl.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}", + "httpMethod": "PATCH", + "id": "managedkafka.projects.locations.clusters.acls.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id} The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name}` `consumerGroup/{resource_name}` `transactionalId/{resource_name}` For acls on all resources that match a prefix: `topicPrefixed/{resource_name}` `consumerGroupPrefixed/{resource_name}` `transactionalIdPrefixed/{resource_name}` For acls on all resources of a given type (i.e. the wildcard literal \"*\"): `allTopics` (represents `topic/*`) `allConsumerGroups` (represents `consumerGroup/*`) `allTransactionalIds` (represents `transactionalId/*`)", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Acl 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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Acl" + }, + "response": { + "$ref": "Acl" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeAclEntry": { + "description": "Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}:removeAclEntry", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.clusters.acls.removeAclEntry", + "parameterOrder": [ + "acl" + ], + "parameters": { + "acl": { + "description": "Required. The name of the acl to remove the acl entry from. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+acl}:removeAclEntry", + "request": { + "$ref": "AclEntry" + }, + "response": { + "$ref": "RemoveAclEntryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "consumerGroups": { "methods": { "delete": { @@ -598,41 +817,494 @@ }, "path": "v1/{+parent}/topics", "response": { - "$ref": "ListTopicsResponse" + "$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" + ] + } + } + } + } + }, + "connectClusters": { + "methods": { + "create": { + "description": "Creates a new Kafka Connect cluster in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.connectClusters.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "connectClusterId": { + "description": "Required. The ID to use for the Connect 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 project/location in which to create the Kafka Connect 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}/connectClusters", + "request": { + "$ref": "ConnectCluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Connect cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.connectClusters.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Kafka Connect cluster to delete. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$", + "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 Kafka Connect cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.connectClusters.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Kafka Connect cluster whose configuration to return. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ConnectCluster" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the Kafka Connect clusters in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.connectClusters.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 Connect 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 `ListConnectClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectClusters` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent project/location whose Connect clusters are to be listed. Structured like `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/connectClusters", + "response": { + "$ref": "ListConnectClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the properties of a single Kafka Connect cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}", + "httpMethod": "PATCH", + "id": "managedkafka.projects.locations.connectClusters.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$", + "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": "ConnectCluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "connectors": { + "methods": { + "create": { + "description": "Creates a new connector in a given Connect cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.connectClusters.connectors.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "connectorId": { + "description": "Required. The ID to use for the connector, which will become the final component of the connector'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-connector-id`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent Connect cluster in which to create the connector. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/connectors", + "request": { + "$ref": "Connector" + }, + "response": { + "$ref": "Connector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.connectClusters.connectors.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the connector to delete. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$", + "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 connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.connectClusters.connectors.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the connector whose configuration to return. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Connector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the connectors in a given Connect cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.connectClusters.connectors.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of connectors 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 `ListConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectors` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent Connect cluster whose connectors are to be listed. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/connectors", + "response": { + "$ref": "ListConnectorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the properties of a connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}", + "httpMethod": "PATCH", + "id": "managedkafka.projects.locations.connectClusters.connectors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$", + "required": true, + "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": "Connector" + }, + "response": { + "$ref": "Connector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pause": { + "description": "Pauses the connector and its tasks.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:pause", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.connectClusters.connectors.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:pause", + "request": { + "$ref": "PauseConnectorRequest" + }, + "response": { + "$ref": "PauseConnectorResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restart": { + "description": "Restarts the connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:restart", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.connectClusters.connectors.restart", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the connector to restart. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restart", + "request": { + "$ref": "RestartConnectorRequest" + }, + "response": { + "$ref": "RestartConnectorResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes the connector and its tasks.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:resume", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.connectClusters.connectors.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", + "request": { + "$ref": "ResumeConnectorRequest" + }, + "response": { + "$ref": "ResumeConnectorResponse" }, "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", + "stop": { + "description": "Stops the connector.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:stop", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.connectClusters.connectors.stop", "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}", + "description": "Required. The name of the connector to stop. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/topics/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/connectClusters/[^/]+/connectors/[^/]+$", "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}", + "path": "v1/{+name}:stop", "request": { - "$ref": "Topic" + "$ref": "StopConnectorRequest" }, "response": { - "$ref": "Topic" + "$ref": "StopConnectorResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -770,7 +1442,7 @@ } } }, - "revision": "20250306", + "revision": "20250414", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -787,6 +1459,81 @@ }, "type": "object" }, + "Acl": { + "description": "Represents the set of ACLs for a given Kafka Resource Pattern, which consists of resource_type, resource_name and pattern_type.", + "id": "Acl", + "properties": { + "aclEntries": { + "description": "Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.", + "items": { + "$ref": "AclEntry" + }, + "type": "array" + }, + "etag": { + "description": "Optional. `etag` is used for concurrency control. An `etag` is returned in the response to `GetAcl` and `CreateAcl`. Callers are required to put that etag in the request to `UpdateAcl` to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster. A terminal 'T' character in the etag indicates that the AclEntries were truncated; more entries for the Acl exist on the Kafka Cluster, but can't be returned in the Acl due to repeated field limits.", + "type": "string" + }, + "name": { + "description": "Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id} The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name}` `consumerGroup/{resource_name}` `transactionalId/{resource_name}` For acls on all resources that match a prefix: `topicPrefixed/{resource_name}` `consumerGroupPrefixed/{resource_name}` `transactionalIdPrefixed/{resource_name}` For acls on all resources of a given type (i.e. the wildcard literal \"*\"): `allTopics` (represents `topic/*`) `allConsumerGroups` (represents `consumerGroup/*`) `allTransactionalIds` (represents `transactionalId/*`)", + "type": "string" + }, + "patternType": { + "description": "Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Output only. The ACL resource name derived from the name. For cluster resource_type, this is always \"kafka-cluster\". Can be the wildcard literal \"*\".", + "readOnly": true, + "type": "string" + }, + "resourceType": { + "description": "Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AclEntry": { + "description": "Represents the access granted for a given Resource Pattern in an ACL.", + "id": "AclEntry", + "properties": { + "host": { + "description": "Required. The host. Must be set to \"*\" for Managed Service for Apache Kafka.", + "type": "string" + }, + "operation": { + "description": "Required. The operation type. Allowed values are (case insensitive): ALL, READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION, DESCRIBE_CONFIGS, ALTER_CONFIGS, and IDEMPOTENT_WRITE. See https://kafka.apache.org/documentation/#operations_resources_and_protocols for valid combinations of resource_type and operation for different Kafka API requests.", + "type": "string" + }, + "permissionType": { + "description": "Required. The permission type. Accepted values are (case insensitive): ALLOW, DENY.", + "type": "string" + }, + "principal": { + "description": "Required. The principal. Specified as Google Cloud account, with the Kafka StandardAuthorizer prefix \"User:\". For example: \"User:test-kafka-client@test-project.iam.gserviceaccount.com\". Can be the wildcard \"User:*\" to refer to all users.", + "type": "string" + } + }, + "type": "object" + }, + "AddAclEntryResponse": { + "description": "Response for AddAclEntry.", + "id": "AddAclEntryResponse", + "properties": { + "acl": { + "$ref": "Acl", + "description": "The updated acl." + }, + "aclCreated": { + "description": "Whether the acl was created as a result of adding the acl entry.", + "type": "boolean" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -879,6 +1626,174 @@ }, "type": "object" }, + "ConnectAccessConfig": { + "description": "The configuration of access to the Kafka Connect cluster.", + "id": "ConnectAccessConfig", + "properties": { + "networkConfigs": { + "description": "Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka Connect cluster. Minimum of 1 network is required. Maximum 10 networks can be specified.", + "items": { + "$ref": "ConnectNetworkConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConnectCluster": { + "description": "An Apache Kafka Connect cluster deployed in a location.", + "id": "ConnectCluster", + "properties": { + "capacityConfig": { + "$ref": "CapacityConfig", + "description": "Required. Capacity configuration for the Kafka Connect cluster." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`.", + "type": "object" + }, + "createTime": { + "description": "Output only. The time when the cluster was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "gcpConfig": { + "$ref": "ConnectGcpConfig", + "description": "Required. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform." + }, + "kafkaCluster": { + "description": "Required. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}", + "type": "string" + }, + "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" + }, + "ConnectGcpConfig": { + "description": "Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform.", + "id": "ConnectGcpConfig", + "properties": { + "accessConfig": { + "$ref": "ConnectAccessConfig", + "description": "Required. Access configuration for the Kafka Connect cluster." + }, + "secretPaths": { + "description": "Optional. Secrets to load into workers. Exact SecretVersions from Secret Manager must be provided -- aliases are not supported. Up to 32 secrets may be loaded into one cluster. Format: projects//secrets//versions/", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConnectNetworkConfig": { + "description": "The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka Connect cluster.", + "id": "ConnectNetworkConfig", + "properties": { + "additionalSubnets": { + "description": "Optional. Additional subnets may be specified. They may be in another region, but must be in the same VPC network. The Connect workers can communicate with network endpoints in either the primary or additional subnets.", + "items": { + "type": "string" + }, + "type": "array" + }, + "dnsDomainNames": { + "description": "Optional. Additional DNS domain names from the subnet's network to be made visible to the Connect Cluster. When using MirrorMaker2, it's necessary to add the bootstrap address's dns domain name of the target cluster to make it visible to the connector. For example: my-kafka-cluster.us-central1.managedkafka.my-project.cloud.goog", + "items": { + "type": "string" + }, + "type": "array" + }, + "primarySubnet": { + "description": "Required. VPC subnet to make available to the Kafka Connect cluster. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id} It is used to create a Private Service Connect (PSC) interface for the Kafka Connect workers. It must be located in the same region as the Kafka Connect cluster. The CIDR range of the subnet must be within the IPv4 address ranges for private networks, as specified in RFC 1918. The primary subnet CIDR range must have a minimum size of /22 (1024 addresses).", + "type": "string" + } + }, + "type": "object" + }, + "Connector": { + "description": "A Kafka Connect connector in a given ConnectCluster.", + "id": "Connector", + "properties": { + "configs": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the connector.", + "enum": [ + "STATE_UNSPECIFIED", + "UNASSIGNED", + "RUNNING", + "PAUSED", + "FAILED", + "RESTARTING", + "STOPPED" + ], + "enumDescriptions": [ + "A state was not specified.", + "The connector is not assigned to any tasks, usually transient.", + "The connector is running.", + "The connector has been paused.", + "The connector has failed. See logs for why.", + "The connector is restarting.", + "The connector has been stopped." + ], + "readOnly": true, + "type": "string" + }, + "taskRestartPolicy": { + "$ref": "TaskRetryPolicy", + "description": "Optional. Restarts the individual tasks of a Connector." + } + }, + "type": "object" + }, "ConsumerGroup": { "description": "A Kafka consumer group in a given cluster.", "id": "ConsumerGroup", @@ -948,6 +1863,24 @@ }, "type": "object" }, + "ListAclsResponse": { + "description": "Response for ListAcls.", + "id": "ListAclsResponse", + "properties": { + "acls": { + "description": "The list of acls in the requested parent. The order of the acls is unspecified.", + "items": { + "$ref": "Acl" + }, + "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" + }, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -973,6 +1906,49 @@ }, "type": "object" }, + "ListConnectClustersResponse": { + "description": "Response for ListConnectClusters.", + "id": "ListConnectClustersResponse", + "properties": { + "connectClusters": { + "description": "The list of Connect clusters in the requested parent.", + "items": { + "$ref": "ConnectCluster" + }, + "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" + }, + "ListConnectorsResponse": { + "description": "Response for ListConnectors.", + "id": "ListConnectorsResponse", + "properties": { + "connectors": { + "description": "The list of connectors in the requested parent.", + "items": { + "$ref": "Connector" + }, + "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" + }, "ListConsumerGroupsResponse": { "description": "Response for ListConsumerGroups.", "id": "ListConsumerGroupsResponse", @@ -1169,6 +2145,18 @@ }, "type": "object" }, + "PauseConnectorRequest": { + "description": "Request for PauseConnector.", + "id": "PauseConnectorRequest", + "properties": {}, + "type": "object" + }, + "PauseConnectorResponse": { + "description": "Response for PauseConnector.", + "id": "PauseConnectorResponse", + "properties": {}, + "type": "object" + }, "RebalanceConfig": { "description": "Defines rebalancing behavior of a Kafka cluster.", "id": "RebalanceConfig", @@ -1190,6 +2178,45 @@ }, "type": "object" }, + "RemoveAclEntryResponse": { + "description": "Response for RemoveAclEntry.", + "id": "RemoveAclEntryResponse", + "properties": { + "acl": { + "$ref": "Acl", + "description": "The updated acl. Returned if the removed acl entry was not the last entry in the acl." + }, + "aclDeleted": { + "description": "Returned with value true if the removed acl entry was the last entry in the acl, resulting in acl deletion.", + "type": "boolean" + } + }, + "type": "object" + }, + "RestartConnectorRequest": { + "description": "Request for RestartConnector.", + "id": "RestartConnectorRequest", + "properties": {}, + "type": "object" + }, + "RestartConnectorResponse": { + "description": "Response for RestartConnector.", + "id": "RestartConnectorResponse", + "properties": {}, + "type": "object" + }, + "ResumeConnectorRequest": { + "description": "Request for ResumeConnector.", + "id": "ResumeConnectorRequest", + "properties": {}, + "type": "object" + }, + "ResumeConnectorResponse": { + "description": "Response for ResumeConnector.", + "id": "ResumeConnectorResponse", + "properties": {}, + "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", @@ -1217,6 +2244,35 @@ }, "type": "object" }, + "StopConnectorRequest": { + "description": "Request for StopConnector.", + "id": "StopConnectorRequest", + "properties": {}, + "type": "object" + }, + "StopConnectorResponse": { + "description": "Response for StopConnector.", + "id": "StopConnectorResponse", + "properties": {}, + "type": "object" + }, + "TaskRetryPolicy": { + "description": "Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively.", + "id": "TaskRetryPolicy", + "properties": { + "maximumBackoff": { + "description": "Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.", + "format": "google-duration", + "type": "string" + }, + "minimumBackoff": { + "description": "Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "Topic": { "description": "A Kafka topic in a given cluster.", "id": "Topic", diff --git a/discovery/meet-v2.json b/discovery/meet-v2.json index e6870bbe579..c651feb0083 100644 --- a/discovery/meet-v2.json +++ b/discovery/meet-v2.json @@ -20,7 +20,7 @@ "canonicalName": "Meet", "description": "Create and manage meetings in Google Meet.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/meet/api", + "documentationLink": "https://developers.google.com/workspace/meet/api", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -457,7 +457,7 @@ "entries": { "methods": { "get": { - "description": "Gets a `TranscriptEntry` resource by entry ID. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.", + "description": "Gets a `TranscriptEntry` resource by entry ID. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation.", "flatPath": "v2/conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}", "httpMethod": "GET", "id": "meet.conferenceRecords.transcripts.entries.get", @@ -483,7 +483,7 @@ ] }, "list": { - "description": "Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.", + "description": "Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation.", "flatPath": "v2/conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries", "httpMethod": "GET", "id": "meet.conferenceRecords.transcripts.entries.list", @@ -546,7 +546,7 @@ ] }, "endActiveConference": { - "description": "Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).", + "description": "Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#end-active-conference).", "flatPath": "v2/spaces/{spacesId}:endActiveConference", "httpMethod": "POST", "id": "meet.spaces.endActiveConference", @@ -555,7 +555,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", + "description": "Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -574,7 +574,7 @@ ] }, "get": { - "description": "Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).", + "description": "Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#get-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "GET", "id": "meet.spaces.get", @@ -583,7 +583,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", + "description": "Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -601,7 +601,7 @@ ] }, "patch": { - "description": "Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).", + "description": "Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#update-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "PATCH", "id": "meet.spaces.patch", @@ -610,7 +610,7 @@ ], "parameters": { "name": { - "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", + "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -638,7 +638,7 @@ } } }, - "revision": "20250127", + "revision": "20250421", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { @@ -665,6 +665,25 @@ }, "type": "object" }, + "ArtifactConfig": { + "description": "Configuration related to meeting artifacts potentially generated by this meeting space.", + "id": "ArtifactConfig", + "properties": { + "recordingConfig": { + "$ref": "RecordingConfig", + "description": "Configuration for recording." + }, + "smartNotesConfig": { + "$ref": "SmartNotesConfig", + "description": "Configuration for auto-smart-notes." + }, + "transcriptionConfig": { + "$ref": "TranscriptionConfig", + "description": "Configuration for auto-transcript." + } + }, + "type": "object" + }, "ConferenceRecord": { "description": "Single instance of a meeting held in a space.", "id": "ConferenceRecord", @@ -858,6 +877,69 @@ }, "type": "object" }, + "ModerationRestrictions": { + "description": "Defines restrictions for features when the meeting is moderated.", + "id": "ModerationRestrictions", + "properties": { + "chatRestriction": { + "description": "Defines who has permission to send chat messages in the meeting space.", + "enum": [ + "RESTRICTION_TYPE_UNSPECIFIED", + "HOSTS_ONLY", + "NO_RESTRICTION" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "Meeting owner and co-host have the permission.", + "All Participants have permissions." + ], + "type": "string" + }, + "defaultJoinAsViewerType": { + "description": "Defines whether to restrict the default role assigned to users as viewer.", + "enum": [ + "DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED", + "ON", + "OFF" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "Users will by default join as viewers.", + "Users will by default join as contributors." + ], + "type": "string" + }, + "presentRestriction": { + "description": "Defines who has permission to share their screen in the meeting space.", + "enum": [ + "RESTRICTION_TYPE_UNSPECIFIED", + "HOSTS_ONLY", + "NO_RESTRICTION" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "Meeting owner and co-host have the permission.", + "All Participants have permissions." + ], + "type": "string" + }, + "reactionRestriction": { + "description": "Defines who has permission to send reactions in the meeting space.", + "enum": [ + "RESTRICTION_TYPE_UNSPECIFIED", + "HOSTS_ONLY", + "NO_RESTRICTION" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "Meeting owner and co-host have the permission.", + "All Participants have permissions." + ], + "type": "string" + } + }, + "type": "object" + }, "Participant": { "description": "User who attended or is attending a conference.", "id": "Participant", @@ -975,6 +1057,27 @@ }, "type": "object" }, + "RecordingConfig": { + "description": "Configuration related to recording in a meeting space.", + "id": "RecordingConfig", + "properties": { + "autoRecordingGeneration": { + "description": "Defines whether a meeting space is automatically recorded when someone with the privilege to record joins the meeting.", + "enum": [ + "AUTO_GENERATION_TYPE_UNSPECIFIED", + "ON", + "OFF" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "The artifact is generated automatically.", + "The artifact is not generated automatically." + ], + "type": "string" + } + }, + "type": "object" + }, "SignedinUser": { "description": "A signed-in user can be: a) An individual joining from a personal computer, mobile device, or through companion mode. b) A robot account used by conference room devices.", "id": "SignedinUser", @@ -992,6 +1095,27 @@ }, "type": "object" }, + "SmartNotesConfig": { + "description": "Configuration related to smart notes in a meeting space. For more information about smart notes, see [\"Take notes for me\" in Google Meet](https://support.google.com/meet/answer/14754931).", + "id": "SmartNotesConfig", + "properties": { + "autoSmartNotesGeneration": { + "description": "Defines whether to automatically generate a summary and recap of the meeting for all invitees in the organization when someone with the privilege to enable smart notes joins the meeting.", + "enum": [ + "AUTO_GENERATION_TYPE_UNSPECIFIED", + "ON", + "OFF" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "The artifact is generated automatically.", + "The artifact is not generated automatically." + ], + "type": "string" + } + }, + "type": "object" + }, "Space": { "description": "Virtual place where conferences are held. Only one active conference can be held in one space at any given time.", "id": "Space", @@ -1015,7 +1139,7 @@ "type": "string" }, "name": { - "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", + "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).", "type": "string" } }, @@ -1041,6 +1165,24 @@ ], "type": "string" }, + "artifactConfig": { + "$ref": "ArtifactConfig", + "description": "Configuration pertaining to the auto-generated artifacts that the meeting supports." + }, + "attendanceReportGenerationType": { + "description": "Whether attendance report is enabled for the meeting space.", + "enum": [ + "ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED", + "GENERATE_REPORT", + "DO_NOT_GENERATE" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "Attendance report will be generated and sent to drive/email.", + "Attendance report will not be generated." + ], + "type": "string" + }, "entryPointAccess": { "description": "Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL", "enum": [ @@ -1054,6 +1196,24 @@ "Only entry points owned by the Google Cloud project that created the space can be used to join meetings in this space. Apps can use the Meet Embed SDK Web or mobile Meet SDKs to create owned entry points." ], "type": "string" + }, + "moderation": { + "description": "The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.", + "enum": [ + "MODERATION_UNSPECIFIED", + "OFF", + "ON" + ], + "enumDescriptions": [ + "Moderation type is not specified. This is used to indicate the user hasn't specified any value as the user does not intend to update the state. Users are not allowed to set the value as unspecified.", + "Moderation is off.", + "Moderation is on." + ], + "type": "string" + }, + "moderationRestrictions": { + "$ref": "ModerationRestrictions", + "description": "When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions." } }, "type": "object" @@ -1142,6 +1302,27 @@ } }, "type": "object" + }, + "TranscriptionConfig": { + "description": "Configuration related to transcription in a meeting space.", + "id": "TranscriptionConfig", + "properties": { + "autoTranscriptionGeneration": { + "description": "Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.", + "enum": [ + "AUTO_GENERATION_TYPE_UNSPECIFIED", + "ON", + "OFF" + ], + "enumDescriptions": [ + "Default value specified by user policy. This should never be returned.", + "The artifact is generated automatically.", + "The artifact is not generated automatically." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 7d2881a3f9b..739aebd27b3 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -108,7 +108,7 @@ "accounts": { "methods": { "createAndConfigure": { - "description": "Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.", + "description": "Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.", "flatPath": "accounts/v1beta/accounts:createAndConfigure", "httpMethod": "POST", "id": "merchantapi.accounts.createAndConfigure", @@ -180,31 +180,6 @@ "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 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", @@ -258,7 +233,7 @@ "type": "string" }, "provider": { - "description": "Required. The aggregation service provider. Format: `providers/{providerId}`", + "description": "Required. The aggregation service provider. Format: `accounts/{providerId}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -306,40 +281,6 @@ "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": { @@ -406,6 +347,69 @@ } } }, + "automaticImprovements": { + "methods": { + "getAutomaticImprovements": { + "description": "Retrieves the automatic improvements of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/automaticImprovements", + "httpMethod": "GET", + "id": "merchantapi.accounts.automaticImprovements.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" + ] + }, + "updateAutomaticImprovements": { + "description": "Updates the automatic improvements of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/automaticImprovements", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.automaticImprovements.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" + ] + } + } + }, "businessIdentity": { "methods": { "getBusinessIdentity": { @@ -717,7 +721,7 @@ "issues": { "methods": { "list": { - "description": "Lists all account issues of a Merchant Center account.", + "description": "Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.issues.list` for each sub-account individually.", "flatPath": "accounts/v1beta/accounts/{accountsId}/issues", "httpMethod": "GET", "id": "merchantapi.accounts.issues.list", @@ -731,7 +735,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100", + "description": "Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100", "format": "int32", "location": "query", "type": "integer" @@ -1107,6 +1111,254 @@ } } }, + "relationships": { + "methods": { + "get": { + "description": "Retrieve an account relationship.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/relationships/{relationshipsId}", + "httpMethod": "GET", + "id": "merchantapi.accounts.relationships.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the account relationship to get.", + "location": "path", + "pattern": "^accounts/[^/]+/relationships/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "AccountRelationship" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "List account relationships for the specified account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/relationships", + "httpMethod": "GET", + "id": "merchantapi.accounts.relationships.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The token returned by the previous `list` request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent account of the account relationship to filter by.", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/relationships", + "response": { + "$ref": "ListAccountRelationshipsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Updates the account relationship. Executing this method requires admin access.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/relationships/{relationshipsId}", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.relationships.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the account relationship.", + "location": "path", + "pattern": "^accounts/[^/]+/relationships/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_id_alias`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "AccountRelationship" + }, + "response": { + "$ref": "AccountRelationship" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "services": { + "methods": { + "approve": { + "description": "Approve an account service proposal.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/services/{servicesId}:approve", + "httpMethod": "POST", + "id": "merchantapi.accounts.services.approve", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the account service to approve.", + "location": "path", + "pattern": "^accounts/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}:approve", + "request": { + "$ref": "ApproveAccountServiceRequest" + }, + "response": { + "$ref": "AccountService" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "get": { + "description": "Retrieve an account service.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/services/{servicesId}", + "httpMethod": "GET", + "id": "merchantapi.accounts.services.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the account service to get.", + "location": "path", + "pattern": "^accounts/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "AccountService" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "List account services for the specified accounts. Supports filtering.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/services", + "httpMethod": "GET", + "id": "merchantapi.accounts.services.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The token returned by the previous `list` request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent account of the account service to filter by.", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/services", + "response": { + "$ref": "ListAccountServicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "propose": { + "description": "Propose an account service.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/services:propose", + "httpMethod": "POST", + "id": "merchantapi.accounts.services.propose", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the parent account for the service.", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/services:propose", + "request": { + "$ref": "ProposeAccountServiceRequest" + }, + "response": { + "$ref": "AccountService" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "reject": { + "description": "Reject an account service (both proposed and approve services can be rejected).", + "flatPath": "accounts/v1beta/accounts/{accountsId}/services/{servicesId}:reject", + "httpMethod": "POST", + "id": "merchantapi.accounts.services.reject", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the account service to reject.", + "location": "path", + "pattern": "^accounts/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}:reject", + "request": { + "$ref": "RejectAccountServiceRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, "shippingSettings": { "methods": { "getShippingSettings": { @@ -1119,7 +1371,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", + "description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsettings`", "location": "path", "pattern": "^accounts/[^/]+/shippingSettings$", "required": true, @@ -1144,7 +1396,7 @@ ], "parameters": { "parent": { - "description": "Required. The account where this product will be inserted. Format: accounts/{account}", + "description": "Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: `accounts/{ACCOUNT_ID}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -1176,7 +1428,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`", + "description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementStates/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`", "location": "path", "pattern": "^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$", "required": true, @@ -1382,14 +1634,14 @@ "accept": { "description": "Accepts a `TermsOfService`. Executing this method requires admin access.", "flatPath": "accounts/v1beta/termsOfService/{termsOfServiceId}:accept", - "httpMethod": "GET", + "httpMethod": "POST", "id": "merchantapi.termsOfService.accept", "parameterOrder": [ "name" ], "parameters": { "account": { - "description": "Required. The account for which to accept the ToS.", + "description": "Required. The account for which to accept the ToS. Format: `accounts/{account}`", "location": "query", "type": "string" }, @@ -1408,7 +1660,7 @@ }, "path": "accounts/v1beta/{+name}:accept", "response": { - "$ref": "Empty" + "$ref": "AcceptTermsOfServiceResponse" }, "scopes": [ "https://www.googleapis.com/auth/content" @@ -1476,9 +1728,20 @@ } } }, - "revision": "20250317", + "revision": "20250427", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { + "AcceptTermsOfServiceResponse": { + "description": "Response message for the `AcceptTermsOfService` method.", + "id": "AcceptTermsOfServiceResponse", + "properties": { + "termsOfServiceAgreementState": { + "$ref": "TermsOfServiceAgreementState", + "description": "The agreement state after accepting the ToS." + } + }, + "type": "object" + }, "Accepted": { "description": "Describes the accepted terms of service.", "id": "Accepted", @@ -1488,12 +1751,12 @@ "type": "string" }, "termsOfService": { - "description": "The accepted [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService).", + "description": "The accepted termsOfService.", "type": "string" }, "validUntil": { "$ref": "Date", - "description": "When set, it states that the accepted [TermsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required [TermsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) is found in the [Required](Required) message." + "description": "When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message." } }, "type": "object" @@ -1531,7 +1794,7 @@ }, "timeZone": { "$ref": "TimeZone", - "description": "Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty." + "description": "Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. The `version` field is not supported, won't be set in responses and will be silently ignored if specified in requests." } }, "type": "object" @@ -1588,6 +1851,97 @@ }, "type": "object" }, + "AccountManagement": { + "description": "`AccountManagement` payload.", + "id": "AccountManagement", + "properties": {}, + "type": "object" + }, + "AccountRelationship": { + "description": "The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).", + "id": "AccountRelationship", + "properties": { + "accountIdAlias": { + "description": "Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the account relationship.", + "type": "string" + }, + "provider": { + "description": "Immutable. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).", + "type": "string" + }, + "providerDisplayName": { + "description": "Output only. The human-readable display name of the provider account.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AccountService": { + "description": "The `AccountService` message represents a specific service that a provider account offers to a merchant account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the merchant and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.", + "id": "AccountService", + "properties": { + "accountAggregation": { + "$ref": "AccountAggregation", + "description": "Service type for account aggregation. This enables the provider, which is a Multi-Client Account (MCA), to manage multiple sub-accounts (client accounts). Through this service, the MCA provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many merchant accounts." + }, + "accountManagement": { + "$ref": "AccountManagement", + "description": "Service type for account management. Enables the provider to perform administrative actions on the merchant's account, such as configuring account settings, managing users, or updating business information." + }, + "campaignsManagement": { + "$ref": "CampaignsManagement", + "description": "Service type for managing advertising campaigns. Grants the provider access to create and manage the merchant's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance." + }, + "externalAccountId": { + "description": "Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.", + "type": "string" + }, + "handshake": { + "$ref": "Handshake", + "description": "Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).", + "readOnly": true + }, + "mutability": { + "description": "Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.", + "enum": [ + "MUTABILITY_UNSPECIFIED", + "MUTABLE", + "IMMUTABLE" + ], + "enumDescriptions": [ + "Unused default value", + "The service can be mutated without restrictions.", + "The service is read-only and must not be mutated." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the account service.", + "type": "string" + }, + "productsManagement": { + "$ref": "ProductsManagement", + "description": "Service type for managing products. This allows the provider to handle product data on behalf of the merchant, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the merchant's product information up-to-date across platforms." + }, + "provider": { + "description": "Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).", + "readOnly": true, + "type": "string" + }, + "providerDisplayName": { + "description": "Output only. The human-readable display name of the provider account.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "AddAccountService": { "description": "Additional instructions to add account services during creation of the account.", "id": "AddAccountService", @@ -1645,6 +1999,12 @@ }, "type": "object" }, + "ApproveAccountServiceRequest": { + "description": "Request to approve an account service.", + "id": "ApproveAccountServiceRequest", + "properties": {}, + "type": "object" + }, "AutofeedSettings": { "description": "Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.", "id": "AutofeedSettings", @@ -1868,6 +2228,12 @@ }, "type": "object" }, + "CampaignsManagement": { + "description": "`CampaignManagement` payload.", + "id": "CampaignsManagement", + "properties": {}, + "type": "object" + }, "CarrierRate": { "description": "A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.", "id": "CarrierRate", @@ -2180,6 +2546,45 @@ }, "type": "object" }, + "Handshake": { + "description": "The current status of establishing of the service. (for example, pending approval or approved).", + "id": "Handshake", + "properties": { + "actor": { + "description": "Output only. The most recent account to modify the account service's `approval_status`.", + "enum": [ + "ACTOR_UNSPECIFIED", + "ACCOUNT", + "OTHER_PARTY" + ], + "enumDescriptions": [ + "Unspecified actor.", + "The last change was done by the account who has this service.", + "The last change was done by the other party who this service points to." + ], + "readOnly": true, + "type": "string" + }, + "approvalState": { + "description": "Output only. The approval state of this handshake.", + "enum": [ + "APPROVAL_STATE_UNSPECIFIED", + "PENDING", + "ESTABLISHED", + "REJECTED" + ], + "enumDescriptions": [ + "Unspecified approval status.", + "The service was proposed and is waiting to be confirmed.", + "Both parties have confirmed the service.", + "The service proposal was rejected." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Headers": { "description": "A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set.", "id": "Headers", @@ -2423,6 +2828,42 @@ }, "type": "object" }, + "ListAccountRelationshipsResponse": { + "description": "Response after trying to list account relationships.", + "id": "ListAccountRelationshipsResponse", + "properties": { + "accountRelationships": { + "description": "The account relationships that match your filter.", + "items": { + "$ref": "AccountRelationship" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountServicesResponse": { + "description": "Response after trying to list account services.", + "id": "ListAccountServicesResponse", + "properties": { + "accountServices": { + "description": "The account services that match your filter.", + "items": { + "$ref": "AccountService" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages.", + "type": "string" + } + }, + "type": "object" + }, "ListAccountsResponse": { "description": "Response message for the `ListAccounts` method.", "id": "ListAccountsResponse", @@ -2662,6 +3103,22 @@ "$ref": "RestockingFee", "description": "Optional. 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." }, + "returnLabelSource": { + "description": "The field specifies the return label source. This field is required when return method is BY_MAIL.", + "enum": [ + "RETURN_LABEL_SOURCE_UNSPECIFIED", + "DOWNLOAD_AND_PRINT", + "IN_THE_PACKAGE", + "CUSTOMER_RESPONSIBILITY" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Download and print.", + "Label include in the package.", + "Customer to provide." + ], + "type": "string" + }, "returnMethods": { "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": { @@ -2752,18 +3209,18 @@ "type": "object" }, "PostalAddress": { - "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", + "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 or 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": "PostalAddress", "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).", + "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 or 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). In 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.", + "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. 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": { @@ -2771,7 +3228,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -2779,7 +3236,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -2799,11 +3256,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, @@ -3008,6 +3465,12 @@ }, "type": "object" }, + "ProductsManagement": { + "description": "`ProductsManagement` payload.", + "id": "ProductsManagement", + "properties": {}, + "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. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", @@ -3057,6 +3520,21 @@ }, "type": "object" }, + "ProposeAccountServiceRequest": { + "description": "Request to propose an account service.", + "id": "ProposeAccountServiceRequest", + "properties": { + "accountService": { + "$ref": "AccountService", + "description": "Required. The account service to propose." + }, + "provider": { + "description": "Required. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).", + "type": "string" + } + }, + "type": "object" + }, "RateGroup": { "description": "Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means \"everything else\". The other `applicable_shipping_labels` must not overlap.", "id": "RateGroup", @@ -3130,16 +3608,22 @@ }, "type": "object" }, + "RejectAccountServiceRequest": { + "description": "Request to reject an account service.", + "id": "RejectAccountServiceRequest", + "properties": {}, + "type": "object" + }, "Required": { "description": "Describes the terms of service which are required to be accepted.", "id": "Required", "properties": { "termsOfService": { - "description": "The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted.", + "description": "The `TermsOfService` that need to be accepted.", "type": "string" }, "tosFileUri": { - "description": "Full URL to the terms of service file. This field is the same as [TermsOfService.file_uri](TermsOfService.file_uri), it is added here for convenience only.", + "description": "Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only.", "type": "string" } }, @@ -3261,7 +3745,7 @@ "type": "boolean" }, "currencyCode": { - "description": "The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.", + "description": "Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.", "type": "string" }, "deliveryCountries": { @@ -3325,7 +3809,7 @@ "type": "object" }, "ShippingSettings": { - "description": "The merchant account's [shipping setting](https://support.google.com/merchants/answer/6069284).", + "description": "The merchant account's [shipping settings](https://support.google.com/merchants/answer/6069284).", "id": "ShippingSettings", "properties": { "etag": { @@ -3333,7 +3817,7 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the shipping setting. Format: `accounts/{account}/shippingSetting`", + "description": "Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`", "type": "string" }, "services": { @@ -3449,7 +3933,7 @@ "type": "object" }, "TermsOfService": { - "description": "The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services (see https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`.", + "description": "The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`.", "id": "TermsOfService", "properties": { "external": { @@ -3484,7 +3968,7 @@ "type": "object" }, "TermsOfServiceAgreementState": { - "description": "This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service: [accepted](TermsOfServiceAggrementState.accepted) will be populated, otherwise it will be empty * If the merchant must sign a terms of service: [required](TermsOfServiceAggrementState.required) will be populated, otherwise it will be empty. Note that both [required](TermsOfServiceAggrementState.required) and [accepted](TermsOfServiceAggrementState.accepted) can be present. In this case the `accepted` terms of services will have an expiration date set in the [valid_until](Accepted.valid_until) field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as [tos_file_uri](Accepted.tos_file_uri). The actual acceptance of the terms of service is done by calling accept on the [TermsOfService](TermsOfService) resource.", + "description": "This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the merchant must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource.", "id": "TermsOfServiceAgreementState", "properties": { "accepted": { diff --git a/discovery/merchantapi-conversions_v1beta.json b/discovery/merchantapi-conversions_v1beta.json index 572f9314b86..ecaba41c7f7 100644 --- a/discovery/merchantapi-conversions_v1beta.json +++ b/discovery/merchantapi-conversions_v1beta.json @@ -119,7 +119,7 @@ ], "parameters": { "parent": { - "description": "Required. The merchant account that will own the new conversion source. Format: accounts/{account}", + "description": "Required. The merchant account that will own the new conversion source. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -147,7 +147,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the conversion source to be deleted. Format: accounts/{account}/conversionSources/{conversion_source}", + "description": "Required. The name of the conversion source to be deleted. Format: `accounts/{account}/conversionSources/{conversion_source}`", "location": "path", "pattern": "^accounts/[^/]+/conversionSources/[^/]+$", "required": true, @@ -172,7 +172,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the conversion source to be fetched. Format: accounts/{account}/conversionSources/{conversion_source}", + "description": "Required. The name of the conversion source to be fetched. Format: `accounts/{account}/conversionSources/{conversion_source}`", "location": "path", "pattern": "^accounts/[^/]+/conversionSources/[^/]+$", "required": true, @@ -208,14 +208,14 @@ "type": "string" }, "parent": { - "description": "Required. The merchant account who owns the collection of conversion sources. Format: accounts/{account}", + "description": "Required. The merchant account who owns the collection of conversion sources. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, "type": "string" }, "showDeleted": { - "description": "Optional. Show deleted (archived) option.", + "description": "Optional. Show deleted (archived) conversion sources. By default, deleted conversion sources are not returned.", "location": "query", "type": "boolean" } @@ -238,7 +238,7 @@ ], "parameters": { "name": { - "description": "Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources.", + "description": "Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: `[a-z]{4}:.+` The four characters before the colon represent the type of conversion source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: * `galk`: For GoogleAnalyticsLink sources. * `mcdn`: For MerchantCenterDestination sources.", "location": "path", "pattern": "^accounts/[^/]+/conversionSources/[^/]+$", "required": true, @@ -272,7 +272,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the conversion source to be undeleted. Format: accounts/{account}/conversionSources/{conversion_source}", + "description": "Required. The name of the conversion source to be undeleted. Format: `accounts/{account}/conversionSources/{conversion_source}`", "location": "path", "pattern": "^accounts/[^/]+/conversionSources/[^/]+$", "required": true, @@ -295,7 +295,7 @@ } } }, - "revision": "20250311", + "revision": "20250416", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -303,11 +303,12 @@ "id": "AttributionSettings", "properties": { "attributionLookbackWindowDays": { - "description": "Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40.", + "description": "Required. Lookback window (in days) used for attribution in this source. Supported values are `7`, `30` & `40`.", "format": "int32", "type": "integer" }, "attributionModel": { + "description": "Required. Attribution model.", "enum": [ "ATTRIBUTION_MODEL_UNSPECIFIED", "CROSS_CHANNEL_LAST_CLICK", @@ -354,7 +355,7 @@ "enumDescriptions": [ "Default value. This value is unused.", "Controlled by the Merchant who owns the Conversion Source.", - "Controlled by the YT Affiliates program." + "Controlled by the Youtube Affiliates program." ], "readOnly": true, "type": "string" @@ -374,7 +375,7 @@ "description": "Conversion Source of type \"Merchant Center Tag Destination\"." }, "name": { - "description": "Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources.", + "description": "Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: `[a-z]{4}:.+` The four characters before the colon represent the type of conversion source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: * `galk`: For GoogleAnalyticsLink sources. * `mcdn`: For MerchantCenterDestination sources.", "readOnly": true, "type": "string" }, @@ -389,7 +390,7 @@ "enumDescriptions": [ "Conversion source has unspecified state.", "Conversion source is fully functional.", - "Conversion source has been archived in the last 30 days and not currently functional. Can be restored using the undelete method.", + "Conversion source has been archived in the last 30 days and is currently not functional. Can be restored using the undelete method.", "Conversion source creation has started but not fully finished yet." ], "readOnly": true, @@ -399,7 +400,7 @@ "type": "object" }, "ConversionType": { - "description": "Message representing a types of conversion events", + "description": "Message representing the type of a conversion event.", "id": "ConversionType", "properties": { "name": { @@ -467,7 +468,7 @@ "properties": { "attributionSettings": { "$ref": "AttributionSettings", - "description": "Required. Attribution settings being used for the Merchant Center Destination." + "description": "Required. Attribution settings used for the Merchant Center Destination." }, "currencyCode": { "description": "Required. Three-letter currency code (ISO 4217). The currency code defines in which currency the conversions sent to this destination will be reported in Merchant Center.", @@ -479,7 +480,7 @@ "type": "string" }, "displayName": { - "description": "Required. Merchant-specified display name for the destination. This is the name that identifies the conversion source within the Merchant Center UI. Limited to 64 characters.", + "description": "Required. Merchant-specified display name for the destination. This is the name that identifies the conversion source within the Merchant Center UI. The maximum length is 64 characters.", "type": "string" } }, diff --git a/discovery/merchantapi-datasources_v1beta.json b/discovery/merchantapi-datasources_v1beta.json index 44e07fd4554..ddf21cc66c9 100644 --- a/discovery/merchantapi-datasources_v1beta.json +++ b/discovery/merchantapi-datasources_v1beta.json @@ -261,7 +261,7 @@ ], "parameters": { "name": { - "description": "Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}`", + "description": "Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`", "location": "path", "pattern": "^accounts/[^/]+/dataSources/[^/]+$", "required": true, @@ -321,11 +321,11 @@ } } }, - "revision": "20250312", + "revision": "20250427", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { - "description": "The [data source](https://support.google.com/merchants/answer/7439058) for the Merchant Center account.", + "description": "The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.", "id": "DataSource", "properties": { "dataSourceId": { @@ -370,7 +370,7 @@ "description": "The [merchant review](https://support.google.com/merchants/answer/7045996) data source." }, "name": { - "description": "Identifier. The name of the data source. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}}`", + "description": "Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}`", "type": "string" }, "primaryProductDataSource": { diff --git a/discovery/merchantapi-inventories_v1beta.json b/discovery/merchantapi-inventories_v1beta.json index d824b814b2b..e24e05d8329 100644 --- a/discovery/merchantapi-inventories_v1beta.json +++ b/discovery/merchantapi-inventories_v1beta.json @@ -300,7 +300,7 @@ } } }, - "revision": "20250311", + "revision": "20250412", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -623,7 +623,7 @@ "type": "string" }, "availability": { - "description": "Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/3061342)", + "description": "Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/6324448).", "type": "string" }, "customAttributes": { diff --git a/discovery/merchantapi-lfp_v1beta.json b/discovery/merchantapi-lfp_v1beta.json index 2596ffdbc9e..accab92a78f 100644 --- a/discovery/merchantapi-lfp_v1beta.json +++ b/discovery/merchantapi-lfp_v1beta.json @@ -139,6 +139,35 @@ } } }, + "lfpMerchantStates": { + "methods": { + "get": { + "description": "Gets the LFP state of a merchant", + "flatPath": "lfp/v1beta/accounts/{accountsId}/lfpMerchantStates/{lfpMerchantStatesId}", + "httpMethod": "GET", + "id": "merchantapi.accounts.lfpMerchantStates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the state to retrieve. Format: `accounts/{account}/lfpMerchantStates/{target_merchant}`", + "location": "path", + "pattern": "^accounts/[^/]+/lfpMerchantStates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "lfp/v1beta/{+name}", + "response": { + "$ref": "LfpMerchantState" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, "lfpSales": { "methods": { "insert": { @@ -298,15 +327,129 @@ } } }, - "revision": "20250311", + "revision": "20250401", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { + "CountrySettings": { + "description": "Country-specific settings for the merchant.", + "id": "CountrySettings", + "properties": { + "freeLocalListingsEnabled": { + "description": "True if this merchant has enabled free local listings in MC.", + "type": "boolean" + }, + "instockServingVerificationState": { + "description": "Output only. The verification state of this merchant's instock serving feature.", + "enum": [ + "VERIFICATION_STATE_UNSPECIFIED", + "VERIFICATION_STATE_NOT_APPROVED", + "VERIFICATION_STATE_IN_PROGRESS", + "VERIFICATION_STATE_APPROVED" + ], + "enumDescriptions": [ + "Verification state unspecified.", + "Verification state not approved.", + "Verification state in progress.", + "Verification state approved." + ], + "readOnly": true, + "type": "string" + }, + "inventoryVerificationState": { + "description": "Output only. The verification state of this merchant's inventory check.", + "enum": [ + "VERIFICATION_STATE_UNSPECIFIED", + "VERIFICATION_STATE_NOT_APPROVED", + "VERIFICATION_STATE_IN_PROGRESS", + "VERIFICATION_STATE_APPROVED" + ], + "enumDescriptions": [ + "Verification state unspecified.", + "Verification state not approved.", + "Verification state in progress.", + "Verification state approved." + ], + "readOnly": true, + "type": "string" + }, + "localInventoryAdsEnabled": { + "description": "True if this merchant has enabled local inventory ads in MC.", + "type": "boolean" + }, + "pickupServingVerificationState": { + "description": "Output only. The verification state of this merchant's pickup serving feature.", + "enum": [ + "VERIFICATION_STATE_UNSPECIFIED", + "VERIFICATION_STATE_NOT_APPROVED", + "VERIFICATION_STATE_IN_PROGRESS", + "VERIFICATION_STATE_APPROVED" + ], + "enumDescriptions": [ + "Verification state unspecified.", + "Verification state not approved.", + "Verification state in progress.", + "Verification state approved." + ], + "readOnly": true, + "type": "string" + }, + "productPageType": { + "description": "Output only. The product page type selected by this merchant.", + "enum": [ + "PRODUCT_PAGE_TYPE_UNSPECIFIED", + "GOOGLE_HOSTED", + "MERCHANT_HOSTED", + "MERCHANT_HOSTED_STORE_SPECIFIC" + ], + "enumDescriptions": [ + "Product page type unspecified.", + "Google hosted product page.", + "Merchant hosted product page.", + "Merchant hosted store specific product page." + ], + "readOnly": true, + "type": "string" + }, + "regionCode": { + "description": "Required. The [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml) for the country for which these settings are defined.", + "type": "string" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "properties": {}, "type": "object" }, + "InventoryStats": { + "description": "The inventory statistics for a merchant.", + "id": "InventoryStats", + "properties": { + "submittedEntries": { + "description": "Number of entries (understanding entry as a pair of product and store) that were built based on provided inventories/sales and submitted to Google.", + "format": "int64", + "type": "string" + }, + "submittedInStockEntries": { + "description": "Number of submitted in stock entries.", + "format": "int64", + "type": "string" + }, + "submittedProducts": { + "description": "Number of products from provided inventories/sales that were created from matches to existing online products provided by the merchant or to the Google catalog.", + "format": "int64", + "type": "string" + }, + "unsubmittedEntries": { + "description": "Number of entries that were built based on provided inventories/sales and couldn't be submitted to Google due to errors like missing product.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "LfpInventory": { "description": "Local Inventory for the merchant.", "id": "LfpInventory", @@ -374,6 +517,41 @@ }, "type": "object" }, + "LfpMerchantState": { + "description": "The LFP state of a merchant.", + "id": "LfpMerchantState", + "properties": { + "countrySettings": { + "description": "Country-specific settings for the merchant.", + "items": { + "$ref": "CountrySettings" + }, + "type": "array" + }, + "inventoryStats": { + "$ref": "InventoryStats", + "description": "The inventory statistics for the merchant." + }, + "linkedGbps": { + "description": "Number of [GBPs](https://www.google.com/business/) this merchant has access to.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Identifier. The name of the `LfpMerchantState` resource. Format: `accounts/{account}/lfpMerchantStates/{target_merchant}`", + "type": "string" + }, + "storeStates": { + "description": "Output only. The state per store from the specified merchant.", + "items": { + "$ref": "LfpStoreState" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "LfpSale": { "description": "A sale for the merchant.", "id": "LfpSale", @@ -502,6 +680,36 @@ }, "type": "object" }, + "LfpStoreState": { + "description": "The state of a specific merchant's store.", + "id": "LfpStoreState", + "properties": { + "matchingState": { + "description": "Output only. The store matching state.", + "enum": [ + "STORE_MATCHING_STATE_UNSPECIFIED", + "STORE_MATCHING_STATE_MATCHED", + "STORE_MATCHING_STATE_FAILED" + ], + "enumDescriptions": [ + "Store matching state unspecified.", + "The `LfpStore` is successfully matched with a Google Business Profile store.", + "The `LfpStore` is not matched with a Google Business Profile store." + ], + "readOnly": true, + "type": "string" + }, + "matchingStateHint": { + "description": "The hint of why the matching has failed (only set if matching_state is FAILED).", + "type": "string" + }, + "storeCode": { + "description": "Required. Immutable. The identifier of this store.", + "type": "string" + } + }, + "type": "object" + }, "ListLfpStoresResponse": { "description": "Response message for the ListLfpStores method.", "id": "ListLfpStoresResponse", diff --git a/discovery/merchantapi-products_v1beta.json b/discovery/merchantapi-products_v1beta.json index 65156d7905e..b5fa65caee8 100644 --- a/discovery/merchantapi-products_v1beta.json +++ b/discovery/merchantapi-products_v1beta.json @@ -124,7 +124,7 @@ "type": "string" }, "name": { - "description": "Required. The name of the product input resource to delete. Format: accounts/{account}/productInputs/{product} where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is \"accounts/123/productInputs/online~en~US~sku123\"", + "description": "Required. The name of the product input resource to delete. Format: `accounts/{account}/productInputs/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/productInputs/online~en~US~sku123`.", "location": "path", "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "required": true, @@ -154,7 +154,7 @@ "type": "string" }, "parent": { - "description": "Required. The account where this product will be inserted. Format: accounts/{account}", + "description": "Required. The account where this product will be inserted. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -187,7 +187,7 @@ "type": "string" }, "name": { - "description": "Identifier. The name of the product input. Format: `\"{productinput.name=accounts/{account}/productInputs/{productinput}}\"` where the last section `productinput` consists of 4 parts: channel~content_language~feed_label~offer_id example for product input name is \"accounts/123/productInputs/online~en~US~sku123\"", + "description": "Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123`", "location": "path", "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "required": true, @@ -225,7 +225,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is \"accounts/123/products/online~en~US~sku123\"", + "description": "Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123`", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$", "required": true, @@ -241,7 +241,7 @@ ] }, "list": { - "description": "Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.", + "description": "Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.", "flatPath": "products/v1beta/accounts/{accountsId}/products", "httpMethod": "GET", "id": "merchantapi.accounts.products.list", @@ -261,7 +261,7 @@ "type": "string" }, "parent": { - "description": "Required. The account to list processed products for. Format: accounts/{account}", + "description": "Required. The account to list processed products for. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -281,7 +281,7 @@ } } }, - "revision": "20250317", + "revision": "20250427", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -698,10 +698,12 @@ "type": "array" }, "taxCategory": { + "deprecated": true, "description": "The tax category of the product.", "type": "string" }, "taxes": { + "deprecated": true, "description": "Tax information.", "items": { "$ref": "Tax" @@ -731,6 +733,25 @@ }, "type": "object" }, + "AutomatedDiscounts": { + "description": "Information regarding Automated Discounts.", + "id": "AutomatedDiscounts", + "properties": { + "gadPrice": { + "$ref": "Price", + "description": "The current sale price for products with a price optimized using Google Automated Discounts (GAD). Absent if the information about the GAD_price of the product is not available." + }, + "priorPrice": { + "$ref": "Price", + "description": "The price prior to the application of the first price reduction. Absent if the information about the prior price of the product is not available." + }, + "priorPriceProgressive": { + "$ref": "Price", + "description": "The price prior to the application of consecutive price reductions. Absent if the information about the prior price of the product is not available." + } + }, + "type": "object" + }, "Certification": { "description": "Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.", "id": "Certification", @@ -1198,7 +1219,7 @@ "type": "object" }, "Product": { - "description": "The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account and in Shopping ads and other surfaces across Google. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.", + "description": "The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.", "id": "Product", "properties": { "attributes": { @@ -1206,6 +1227,11 @@ "description": "Output only. A list of product attributes.", "readOnly": true }, + "automatedDiscounts": { + "$ref": "AutomatedDiscounts", + "description": "Output only. The automated discounts information for the product.", + "readOnly": true + }, "channel": { "description": "Output only. The [channel](https://support.google.com/merchants/answer/7361332) of the product.", "enum": [ @@ -1245,7 +1271,7 @@ "type": "string" }, "name": { - "description": "The name of the product. Format: `\"{product.name=accounts/{account}/products/{product}}\"` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is \"accounts/123/products/online~en~US~sku123\"", + "description": "The name of the product. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123`", "type": "string" }, "offerId": { @@ -1389,7 +1415,7 @@ "type": "object" }, "ProductInput": { - "description": "This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112).", + "description": "This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.", "id": "ProductInput", "properties": { "attributes": { @@ -1415,7 +1441,7 @@ "type": "string" }, "customAttributes": { - "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 additional attributes used for Buy on Google. 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. 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" }, @@ -1426,7 +1452,7 @@ "type": "string" }, "name": { - "description": "Identifier. The name of the product input. Format: `\"{productinput.name=accounts/{account}/productInputs/{productinput}}\"` where the last section `productinput` consists of 4 parts: channel~content_language~feed_label~offer_id example for product input name is \"accounts/123/productInputs/online~en~US~sku123\"", + "description": "Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123`", "type": "string" }, "offerId": { @@ -1434,12 +1460,12 @@ "type": "string" }, "product": { - "description": "Output only. The name of the processed product. Format: `\"{product.name=accounts/{account}/products/{product}}\"`", + "description": "Output only. The name of the processed product. Format: `accounts/{account}/products/{product}`", "readOnly": true, "type": "string" }, "versionNumber": { - "description": "Optional. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. If the operation is prevented, the aborted exception will be thrown.", + "description": "Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown.", "format": "int64", "type": "string" } diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index b219fc08531..9cdec418aa0 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1684,7 +1690,7 @@ } } }, - "revision": "20250227", + "revision": "20250324", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index 10b0d61bb59..8f4cc5a61fb 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1796,7 +1802,7 @@ } } }, - "revision": "20250227", + "revision": "20250410", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2323,6 +2329,13 @@ "kmsKey": { "description": "Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.", "type": "string" + }, + "kmsKeys": { + "description": "Optional. The list of fully qualified customer provided Cloud KMS key names for the multi-regional service. Each key must be in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index b68fcf8777e..2f0eb4ff622 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1796,7 +1802,7 @@ } } }, - "revision": "20250227", + "revision": "20250410", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2323,6 +2329,13 @@ "kmsKey": { "description": "Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.", "type": "string" + }, + "kmsKeys": { + "description": "Optional. The list of fully qualified customer provided Cloud KMS key names for the multi-regional service. Each key must be in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/migrationcenter-v1.json b/discovery/migrationcenter-v1.json index edab12e0369..a39040f2ee8 100644 --- a/discovery/migrationcenter-v1.json +++ b/discovery/migrationcenter-v1.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -440,6 +446,11 @@ "required": true, "type": "string" }, + "showHidden": { + "description": "Optional. When this value is set to 'true,' the response will include all assets, including those that are hidden.", + "location": "query", + "type": "boolean" + }, "view": { "description": "View of the assets. Defaults to BASIC.", "enum": [ @@ -2396,7 +2407,7 @@ } } }, - "revision": "20250227", + "revision": "20250422", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2432,6 +2443,10 @@ "filter": { "description": "Optional. The aggregation will be performed on assets that match the provided filter.", "type": "string" + }, + "showHidden": { + "description": "Optional. When this value is set to 'true,' the response will include all assets, including those that are hidden.", + "type": "boolean" } }, "type": "object" @@ -2639,6 +2654,20 @@ "description": "Output only. Asset information specific for logical databases.", "readOnly": true }, + "hidden": { + "description": "Optional. Indicates if the asset is hidden.", + "type": "boolean" + }, + "hideReason": { + "description": "Optional. An optional reason for marking this asset as hidden.", + "type": "string" + }, + "hideTime": { + "description": "Output only. The timestamp when the asset was marked as hidden.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "insightList": { "$ref": "InsightList", "description": "Output only. The list of insights associated with the asset.", diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index 5f515945218..45a2e098bdf 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2548,7 +2554,7 @@ } } }, - "revision": "20250312", + "revision": "20250422", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -4524,6 +4530,14 @@ "readOnly": true, "type": "string" }, + "recommendedVersions": { + "description": "Output only. The recommended versions of the discovery client.", + "items": { + "$ref": "DiscoveryClientDiscoveryClientRecommendedVersion" + }, + "readOnly": true, + "type": "array" + }, "serviceAccount": { "description": "Required. Service account used by the discovery client for various operation.", "type": "string" @@ -4575,6 +4589,23 @@ }, "type": "object" }, + "DiscoveryClientDiscoveryClientRecommendedVersion": { + "description": "Discovery client recommended version.", + "id": "DiscoveryClientDiscoveryClientRecommendedVersion", + "properties": { + "uri": { + "description": "Output only. The URI of the discovery client version.", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Output only. The version of the discovery client.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "DiskEntry": { "description": "Single disk entry.", "id": "DiskEntry", @@ -4615,6 +4646,7 @@ }, "vmwareConfig": { "$ref": "VmwareDiskConfig", + "deprecated": true, "description": "VMware disk details." } }, diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index 7e66dfbb1f8..16543322f0e 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -753,7 +753,7 @@ } } }, - "revision": "20250227", + "revision": "20250329", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1448,7 +1448,9 @@ "UPTIME_CHECK_FAILURE", "CLOUD_ALERTING_ALERT", "SERVICE_HEALTH_INCIDENT", - "SAP_BACKINT" + "SAP_BACKINT", + "SAP_AVAILABILITY", + "SAP_OPERATIONS" ], "enumDescriptions": [ "No event type specified.", @@ -1473,7 +1475,9 @@ "Failure of a Cloud Monitoring uptime check.", "Alerts from Cloud Alerting", "Incidents from Service Health", - "Agent for SAP Backint related events." + "Agent for SAP Backint related events.", + "Agent for SAP availability related events.", + "Agent for SAP operations related events." ], "type": "string" }, diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index 196b45f0a4f..eb0d97fb2aa 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -2720,7 +2720,7 @@ } } }, - "revision": "20250227", + "revision": "20250323", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -4423,6 +4423,13 @@ "unit": { "description": "The unit in which all time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. If different time_series have different units (for example, because they come from different metric types, or a unit is absent), then unit will be \"{not_a_unit}\".", "type": "string" + }, + "unreachable": { + "description": "Cloud regions that were unreachable which may have caused incomplete data to be returned.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -6097,6 +6104,10 @@ }, "type": "array" }, + "disabled": { + "description": "Whether the check is disabled or not.", + "type": "boolean" + }, "displayName": { "description": "A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.", "type": "string" diff --git a/discovery/mybusinessaccountmanagement-v1.json b/discovery/mybusinessaccountmanagement-v1.json index b8df7e8c826..00f3d508ab0 100644 --- a/discovery/mybusinessaccountmanagement-v1.json +++ b/discovery/mybusinessaccountmanagement-v1.json @@ -530,7 +530,7 @@ } } }, - "revision": "20241120", + "revision": "20250319", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { @@ -844,18 +844,18 @@ "type": "object" }, "PostalAddress": { - "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", + "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 or 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": "PostalAddress", "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).", + "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 or 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). In 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.", + "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. 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": { @@ -863,7 +863,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -871,7 +871,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -891,11 +891,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/mybusinessbusinessinformation-v1.json b/discovery/mybusinessbusinessinformation-v1.json index 2621438ac0b..d6be2bfd8c1 100644 --- a/discovery/mybusinessbusinessinformation-v1.json +++ b/discovery/mybusinessbusinessinformation-v1.json @@ -612,7 +612,7 @@ } } }, - "revision": "20250217", + "revision": "20250319", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1387,18 +1387,18 @@ "type": "object" }, "PostalAddress": { - "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", + "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 or 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": "PostalAddress", "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).", + "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 or 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). In 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.", + "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. 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": { @@ -1406,7 +1406,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -1414,7 +1414,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -1434,11 +1434,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/mybusinessverifications-v1.json b/discovery/mybusinessverifications-v1.json index 7474acd1966..1395865d531 100644 --- a/discovery/mybusinessverifications-v1.json +++ b/discovery/mybusinessverifications-v1.json @@ -237,7 +237,7 @@ } } }, - "revision": "20241120", + "revision": "20250319", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { @@ -370,18 +370,18 @@ "type": "object" }, "PostalAddress": { - "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", + "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 or 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": "PostalAddress", "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).", + "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 or 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). In 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.", + "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. 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": { @@ -389,7 +389,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -397,7 +397,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -417,11 +417,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/netapp-v1.json b/discovery/netapp-v1.json index eaddeb1307f..3b099e2bf41 100644 --- a/discovery/netapp-v1.json +++ b/discovery/netapp-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2264,7 +2270,7 @@ } } }, - "revision": "20250129", + "revision": "20250326", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -2402,6 +2408,11 @@ "description": "A NetApp Backup.", "id": "Backup", "properties": { + "backupRegion": { + "description": "Output only. Region in which backup is stored. Format: `projects/{project_id}/locations/{location}`", + "readOnly": true, + "type": "string" + }, "backupType": { "description": "Output only. Type of backup, manually created or created by a backup policy.", "enum": [ @@ -2485,6 +2496,11 @@ "readOnly": true, "type": "string" }, + "volumeRegion": { + "description": "Output only. Region of the volume from which the backup was created. Format: `projects/{project_id}/locations/{location}`", + "readOnly": true, + "type": "string" + }, "volumeUsageBytes": { "description": "Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.", "format": "int64", @@ -2600,6 +2616,24 @@ "description": "A NetApp BackupVault.", "id": "BackupVault", "properties": { + "backupRegion": { + "description": "Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`", + "type": "string" + }, + "backupVaultType": { + "description": "Optional. Type of backup vault to be created. Default is IN_REGION.", + "enum": [ + "BACKUP_VAULT_TYPE_UNSPECIFIED", + "IN_REGION", + "CROSS_REGION" + ], + "enumDescriptions": [ + "BackupVault type not set.", + "BackupVault type is IN_REGION.", + "BackupVault type is CROSS_REGION." + ], + "type": "string" + }, "createTime": { "description": "Output only. Create time of the backup vault.", "format": "google-datetime", @@ -2610,6 +2644,11 @@ "description": "Description of the backup vault.", "type": "string" }, + "destinationBackupVault": { + "description": "Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", + "readOnly": true, + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -2621,6 +2660,16 @@ "description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", "type": "string" }, + "sourceBackupVault": { + "description": "Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", + "readOnly": true, + "type": "string" + }, + "sourceRegion": { + "description": "Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", + "readOnly": true, + "type": "string" + }, "state": { "description": "Output only. The backup vault state.", "enum": [ @@ -4083,7 +4132,7 @@ "id": "TieringPolicy", "properties": { "coolingThresholdDays": { - "description": "Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.", + "description": "Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.", "format": "int32", "type": "integer" }, diff --git a/discovery/netapp-v1beta1.json b/discovery/netapp-v1beta1.json index 502498836d3..433bc508068 100644 --- a/discovery/netapp-v1beta1.json +++ b/discovery/netapp-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2264,7 +2270,7 @@ } } }, - "revision": "20250129", + "revision": "20250326", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -2402,6 +2408,11 @@ "description": "A NetApp Backup.", "id": "Backup", "properties": { + "backupRegion": { + "description": "Output only. Region in which backup is stored. Format: `projects/{project_id}/locations/{location}`", + "readOnly": true, + "type": "string" + }, "backupType": { "description": "Output only. Type of backup, manually created or created by a backup policy.", "enum": [ @@ -2485,6 +2496,11 @@ "readOnly": true, "type": "string" }, + "volumeRegion": { + "description": "Output only. Region of the volume from which the backup was created. Format: `projects/{project_id}/locations/{location}`", + "readOnly": true, + "type": "string" + }, "volumeUsageBytes": { "description": "Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.", "format": "int64", @@ -2600,6 +2616,24 @@ "description": "A NetApp BackupVault.", "id": "BackupVault", "properties": { + "backupRegion": { + "description": "Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`", + "type": "string" + }, + "backupVaultType": { + "description": "Optional. Type of backup vault to be created. Default is IN_REGION.", + "enum": [ + "BACKUP_VAULT_TYPE_UNSPECIFIED", + "IN_REGION", + "CROSS_REGION" + ], + "enumDescriptions": [ + "BackupVault type not set.", + "BackupVault type is IN_REGION.", + "BackupVault type is CROSS_REGION." + ], + "type": "string" + }, "createTime": { "description": "Output only. Create time of the backup vault.", "format": "google-datetime", @@ -2610,6 +2644,11 @@ "description": "Description of the backup vault.", "type": "string" }, + "destinationBackupVault": { + "description": "Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", + "readOnly": true, + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -2621,6 +2660,16 @@ "description": "Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.", "type": "string" }, + "sourceBackupVault": { + "description": "Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`", + "readOnly": true, + "type": "string" + }, + "sourceRegion": { + "description": "Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`", + "readOnly": true, + "type": "string" + }, "state": { "description": "Output only. The backup vault state.", "enum": [ @@ -3934,6 +3983,10 @@ "readOnly": true, "type": "string" }, + "customPerformanceEnabled": { + "description": "Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false", + "type": "boolean" + }, "description": { "description": "Optional. Description of the storage pool", "type": "string" @@ -4047,6 +4100,16 @@ "readOnly": true, "type": "string" }, + "totalIops": { + "description": "Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps", + "format": "int64", + "type": "string" + }, + "totalThroughputMibps": { + "description": "Optional. Custom Performance Total Throughput of the pool (in MiB/s)", + "format": "int64", + "type": "string" + }, "volumeCapacityGib": { "description": "Output only. Allocated size of all volumes in GIB in the storage pool", "format": "int64", @@ -4083,7 +4146,7 @@ "id": "TieringPolicy", "properties": { "coolingThresholdDays": { - "description": "Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31.", + "description": "Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.", "format": "int32", "type": "integer" }, diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index 2cc03b8a566..9508569250d 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2919,7 +2925,7 @@ } } }, - "revision": "20250305", + "revision": "20250414", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -3649,6 +3655,17 @@ "description": "A description of this resource.", "type": "string" }, + "excludeCidrRanges": { + "description": "Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks", + "items": { + "type": "string" + }, + "type": "array" + }, + "immutable": { + "description": "Optional. Immutable ranges cannot have their fields modified, except for labels and description.", + "type": "boolean" + }, "ipCidrRange": { "description": "The IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly.", "type": "string" @@ -3809,6 +3826,14 @@ "readOnly": true, "type": "string" }, + "proposedExcludeExportRanges": { + "description": "Output only. The proposed exclude export IP ranges waiting for hub administration's approval.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "proposedIncludeExportRanges": { "description": "Optional. The proposed include export IP ranges waiting for hub administration's approval.", "items": { @@ -3873,7 +3898,15 @@ "type": "array" }, "producerVpcSpokes": { - "description": "Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. 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.", + "description": "Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected through 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.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "proposedExcludeExportRanges": { + "description": "Output only. The proposed exclude export IP ranges waiting for hub administration's approval.", "items": { "type": "string" }, diff --git a/discovery/networkconnectivity-v1alpha1.json b/discovery/networkconnectivity-v1alpha1.json index d6bd95a44af..f757487b4b9 100644 --- a/discovery/networkconnectivity-v1alpha1.json +++ b/discovery/networkconnectivity-v1alpha1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1116,9 +1122,39 @@ } } }, - "revision": "20250219", + "revision": "20250414", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { + "AllocationOptions": { + "description": "Range auto-allocation options, to be optionally used when CIDR block is not explicitly set.", + "id": "AllocationOptions", + "properties": { + "allocationStrategy": { + "description": "Optional. Allocation strategy Not setting this field when the allocation is requested means an implementation defined strategy is used.", + "enum": [ + "ALLOCATION_STRATEGY_UNSPECIFIED", + "RANDOM", + "FIRST_AVAILABLE", + "RANDOM_FIRST_N_AVAILABLE", + "FIRST_SMALLEST_FITTING" + ], + "enumDescriptions": [ + "Unspecified strategy must be used when the range is specified explicitly using ip_cidr_range field. Othherwise unspefified means using the default strategy.", + "Random strategy, the legacy algorithm, used for backwards compatibility. This allocation strategy remains efficient in the case of concurrent allocation requests in the same peered network space and doesn't require providing the level of concurrency in an explicit parameter, but it is prone to fragmenting available address space.", + "Pick the first available address range. This strategy is deterministic and the result is easy to predict.", + "Pick an arbitrary range out of the first N available ones. The N will be set in the first_available_ranges_lookup_size field. This strategy should be used when concurrent allocation requests are made in the same space of peered networks while the fragmentation of the addrress space is reduced.", + "Pick the smallest but fitting available range. This deterministic strategy minimizes fragmentation of the address space." + ], + "type": "string" + }, + "firstAvailableRangesLookupSize": { + "description": "Optional. This field must be set only when allocation_strategy is set to RANDOM_FIRST_N_AVAILABLE. The value should be the maximum expected parallelism of range creation requests issued to the same space of peered netwroks.", + "format": "int32", + "type": "integer" + } + }, + "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", @@ -1375,6 +1411,10 @@ "description": "The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it.", "id": "InternalRange", "properties": { + "allocationOptions": { + "$ref": "AllocationOptions", + "description": "Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length)." + }, "createTime": { "description": "Time when the internal range was created.", "format": "google-datetime", @@ -1384,6 +1424,13 @@ "description": "A description of this resource.", "type": "string" }, + "excludeCidrRanges": { + "description": "Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks", + "items": { + "type": "string" + }, + "type": "array" + }, "immutable": { "description": "Optional. Immutable ranges cannot have their fields modified, except for labels and description.", "type": "boolean" diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index 361302c10e6..92d2f01db18 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -758,7 +764,7 @@ } } }, - "revision": "20250305", + "revision": "20250416", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -797,6 +803,7 @@ "FIREWALL_CONFIG_NOT_FOUND", "ROUTE_CONFIG_NOT_FOUND", "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", + "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", "SOURCE_REDIS_CLUSTER_UNSUPPORTED", "SOURCE_REDIS_INSTANCE_UNSUPPORTED", @@ -843,6 +850,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -874,7 +882,8 @@ "Aborted because expected network configuration was missing.", "Aborted because expected firewall configuration was missing.", "Aborted because expected route configuration was missing.", - "Aborted because a PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", + "Aborted because PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", + "Aborted because endpoint selection for the Google-managed service is ambiguous (several endpoints satisfy test input).", "Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported.", "Aborted because tests with a Redis Cluster as a source are not supported.", "Aborted because tests with a Redis Instance as a source are not supported.", @@ -1119,7 +1128,7 @@ "id": "ConnectivityTest", "properties": { "bypassFirewallChecks": { - "description": "Whether the test should skip firewall checking. If not provided, we assume false.", + "description": "Whether the analysis should skip firewall checking. Default value is false.", "type": "boolean" }, "createTime": { @@ -1134,7 +1143,7 @@ }, "destination": { "$ref": "Endpoint", - "description": "Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test." + "description": "Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, URI of a supported endpoint, project ID, or VPC network to identify the destination location. Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination that you don't intend to test." }, "displayName": { "description": "Output only. The display name of a Connectivity Test.", @@ -1184,7 +1193,7 @@ }, "source": { "$ref": "Endpoint", - "description": "Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test." + "description": "Required. Source specification of the Connectivity Test. You can use a combination of source IP address, URI of a supported endpoint, project ID, or VPC network to identify the source location. Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don't intend to test." }, "updateTime": { "description": "Output only. The time the test's configuration was updated.", @@ -1380,7 +1389,12 @@ "NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION", "NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION", "NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION", - "PRIVATE_NAT_TO_PSC_ENDPOINT_UNSUPPORTED" + "PRIVATE_NAT_TO_PSC_ENDPOINT_UNSUPPORTED", + "PSC_PORT_MAPPING_PORT_MISMATCH", + "PSC_PORT_MAPPING_WITHOUT_PSC_CONNECTION_UNSUPPORTED", + "UNSUPPORTED_ROUTE_MATCHED_FOR_NAT64_DESTINATION", + "TRAFFIC_FROM_HYBRID_ENDPOINT_TO_INTERNET_DISALLOWED", + "NO_MATCHING_NAT64_GATEWAY" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1401,9 +1415,9 @@ "The packet does not match a policy-based VPN tunnel local selector.", "The packet does not match a policy-based VPN tunnel remote selector.", "Packet with internal destination address sent to the internet gateway.", - "Instance with only an internal IP address tries to access Google API and services, but private Google access is not enabled in the subnet.", + "Endpoint with only an internal IP address tries to access Google API and services, but Private Google Access is not enabled in the subnet or is not applicable.", "Source endpoint tries to access Google API and services through the VPN tunnel to another network, but Private Google Access needs to be enabled in the source endpoint network.", - "Instance with only an internal IP address tries to access external hosts, but Cloud NAT is not enabled in the subnet, unless special configurations on a VM allow this connection.", + "Endpoint with only an internal IP address tries to access external hosts, but there is no matching Cloud NAT gateway in the subnet.", "Destination internal address cannot be resolved to a known target. If this is a shared VPC scenario, verify if the service project ID is provided as test input. Otherwise, verify if the IP address is being used in the project.", "Forwarding rule's protocol and ports do not match the packet header.", "Forwarding rule does not have backends configured.", @@ -1467,7 +1481,12 @@ "Packet from the non-GCP (on-prem) or unknown GCP network is dropped due to the destination IP address not belonging to any IP prefix advertised via BGP by the Cloud Router.", "Packet from the non-GCP (on-prem) or unknown GCP network is dropped due to the destination IP address not belonging to any IP prefix included to the local traffic selector of the VPN tunnel.", "Packet from the unknown peered network is dropped due to no known route from the source network to the destination IP address.", - "Sending packets processed by the Private NAT Gateways to the Private Service Connect endpoints is not supported." + "Sending packets processed by the Private NAT Gateways to the Private Service Connect endpoints is not supported.", + "Packet is sent to the PSC port mapping service, but its destination port does not match any port mapping rules.", + "Sending packets directly to the PSC port mapping service without going through the PSC connection is not supported.", + "Packet with destination IP address within the reserved NAT64 range is dropped due to matching a route of an unsupported type.", + "Packet could be dropped because hybrid endpoint like a VPN gateway or Interconnect is not allowed to send traffic to the Internet.", + "Packet with destination IP address within the reserved NAT64 range is dropped due to no matching NAT gateway in the subnet." ], "type": "string" }, @@ -1513,22 +1532,22 @@ "properties": { "appEngineVersion": { "$ref": "AppEngineVersionEndpoint", - "description": "An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions)." + "description": "An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions). Applicable only to source endpoint." }, "cloudFunction": { "$ref": "CloudFunctionEndpoint", - "description": "A [Cloud Function](https://cloud.google.com/functions)." + "description": "A [Cloud Function](https://cloud.google.com/functions). Applicable only to source endpoint." }, "cloudRunRevision": { "$ref": "CloudRunRevisionEndpoint", - "description": "A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get)" + "description": "A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint." }, "cloudSqlInstance": { "description": "A [Cloud SQL](https://cloud.google.com/sql) instance URI.", "type": "string" }, "forwardingRule": { - "description": "A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Format: projects/{project}/global/forwardingRules/{id} or projects/{project}/regions/{region}/forwardingRules/{id}", + "description": "A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: projects/{project}/global/forwardingRules/{id} or projects/{project}/regions/{region}/forwardingRules/{id}", "type": "string" }, "forwardingRuleTarget": { @@ -1603,7 +1622,7 @@ "type": "string" }, "network": { - "description": "A Compute Engine network URI.", + "description": "A VPC network URI.", "type": "string" }, "networkType": { @@ -1616,7 +1635,7 @@ "enumDescriptions": [ "Default type if unspecified.", "A network hosted within Google Cloud. To receive more detailed output, specify the URI for the source or destination network.", - "A network hosted outside of Google Cloud. This can be an on-premises network, or a network hosted by another cloud provider." + "A network hosted outside of Google Cloud. This can be an on-premises network, an internet resource or a network hosted by another cloud provider." ], "type": "string" }, @@ -1626,15 +1645,15 @@ "type": "integer" }, "projectId": { - "description": "Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.", + "description": "Project ID where the endpoint is located. The project ID can be derived from the URI if you provide a endpoint or network URI. The following are two cases where you may need to provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.", "type": "string" }, "redisCluster": { - "description": "A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI.", + "description": "A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. Applicable only to destination endpoint.", "type": "string" }, "redisInstance": { - "description": "A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI.", + "description": "A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. Applicable only to destination endpoint.", "type": "string" } }, @@ -1932,7 +1951,8 @@ "CLOUD_DNS", "GOOGLE_API", "GOOGLE_API_PSC", - "GOOGLE_API_VPC_SC" + "GOOGLE_API_VPC_SC", + "SERVERLESS_VPC_ACCESS" ], "enumDescriptions": [ "Unspecified Google Service.", @@ -1941,7 +1961,8 @@ "Connectivity from Cloud DNS to forwarding targets or alternate name servers that use private routing. https://cloud.google.com/dns/docs/zones/forwarding-zones#firewall-rules https://cloud.google.com/dns/docs/policies#firewall-rules", "private.googleapis.com and restricted.googleapis.com", "Google API via Private Service Connect. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis", - "Google API via VPC Service Controls. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis" + "Google API via VPC Service Controls. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis", + "Google API via Serverless VPC Access. https://cloud.google.com/vpc/docs/serverless-vpc-access" ], "type": "string" }, @@ -1987,6 +2008,10 @@ "description": "URI of the PSC network attachment the NIC is attached to (if relevant).", "type": "string" }, + "running": { + "description": "Indicates whether the Compute Engine instance is running.", + "type": "boolean" + }, "serviceAccount": { "deprecated": true, "description": "Service account authorized for the instance.", @@ -2541,7 +2566,14 @@ }, "destinationEgressLocation": { "$ref": "EdgeLocation", - "description": "The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field *must not* be used as an indication that the destination/source is part of the Google network." + "description": "The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network." + }, + "edgeResponses": { + "description": "Probing results for all edge devices.", + "items": { + "$ref": "SingleEdgeResponse" + }, + "type": "array" }, "endpointInfo": { "$ref": "EndpointInfo", @@ -2551,6 +2583,10 @@ "$ref": "Status", "description": "Details about an internal failure or the cancellation of active probing." }, + "probedAllDevices": { + "description": "Whether all relevant edge devices were probed.", + "type": "boolean" + }, "probingLatency": { "$ref": "LatencyDistribution", "description": "Latency as measured by active probing in one direction: from the source to the destination endpoint." @@ -2974,6 +3010,53 @@ }, "type": "object" }, + "SingleEdgeResponse": { + "description": "Probing results for a single edge device.", + "id": "SingleEdgeResponse", + "properties": { + "destinationEgressLocation": { + "$ref": "EdgeLocation", + "description": "The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network." + }, + "destinationRouter": { + "description": "Router name in the format '{router}.{metroshard}'. For example: pf01.aaa01, pr02.aaa01.", + "type": "string" + }, + "probingLatency": { + "$ref": "LatencyDistribution", + "description": "Latency as measured by active probing in one direction: from the source to the destination endpoint." + }, + "result": { + "description": "The overall result of active probing for this egress device.", + "enum": [ + "PROBING_RESULT_UNSPECIFIED", + "REACHABLE", + "UNREACHABLE", + "REACHABILITY_INCONSISTENT", + "UNDETERMINED" + ], + "enumDescriptions": [ + "No result was specified.", + "At least 95% of packets reached the destination.", + "No packets reached the destination.", + "Less than 95% of packets reached the destination.", + "Reachability could not be determined. Possible reasons are: * The user lacks permission to access some of the network resources required to run the test. * No valid source endpoint could be derived from the request. * An internal error occurred." + ], + "type": "string" + }, + "sentProbeCount": { + "description": "Number of probes sent.", + "format": "int32", + "type": "integer" + }, + "successfulProbeCount": { + "description": "Number of probes that reached the destination.", + "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", @@ -3420,7 +3503,7 @@ "type": "string" }, "state": { - "description": "Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.", + "description": "Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.", "enum": [ "STATE_UNSPECIFIED", "ENABLED", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 4f875d282b1..de6ebe94337 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -346,6 +352,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -961,7 +973,7 @@ } } }, - "revision": "20250305", + "revision": "20250423", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1000,6 +1012,7 @@ "FIREWALL_CONFIG_NOT_FOUND", "ROUTE_CONFIG_NOT_FOUND", "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", + "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", "SOURCE_REDIS_CLUSTER_UNSUPPORTED", "SOURCE_REDIS_INSTANCE_UNSUPPORTED", @@ -1046,6 +1059,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1077,7 +1091,8 @@ "Aborted because expected network configuration was missing.", "Aborted because expected firewall configuration was missing.", "Aborted because expected route configuration was missing.", - "Aborted because a PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", + "Aborted because PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", + "Aborted because endpoint selection for the Google-managed service is ambiguous (several endpoints satisfy test input).", "Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported.", "Aborted because tests with a Redis Cluster as a source are not supported.", "Aborted because tests with a Redis Instance as a source are not supported.", @@ -1322,7 +1337,7 @@ "id": "ConnectivityTest", "properties": { "bypassFirewallChecks": { - "description": "Whether the test should skip firewall checking. If not provided, we assume false.", + "description": "Whether the analysis should skip firewall checking. Default value is false.", "type": "boolean" }, "createTime": { @@ -1337,7 +1352,7 @@ }, "destination": { "$ref": "Endpoint", - "description": "Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test." + "description": "Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, URI of a supported endpoint, project ID, or VPC network to identify the destination location. Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination that you don't intend to test." }, "displayName": { "description": "Output only. The display name of a Connectivity Test.", @@ -1387,7 +1402,7 @@ }, "source": { "$ref": "Endpoint", - "description": "Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test." + "description": "Required. Source specification of the Connectivity Test. You can use a combination of source IP address, URI of a supported endpoint, project ID, or VPC network to identify the source location. Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don't intend to test." }, "updateTime": { "description": "Output only. The time the test's configuration was updated.", @@ -1583,7 +1598,13 @@ "NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION", "NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION", "NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION", - "PRIVATE_NAT_TO_PSC_ENDPOINT_UNSUPPORTED" + "PRIVATE_NAT_TO_PSC_ENDPOINT_UNSUPPORTED", + "PSC_PORT_MAPPING_PORT_MISMATCH", + "PSC_PORT_MAPPING_WITHOUT_PSC_CONNECTION_UNSUPPORTED", + "UNSUPPORTED_ROUTE_MATCHED_FOR_NAT64_DESTINATION", + "TRAFFIC_FROM_HYBRID_ENDPOINT_TO_INTERNET_DISALLOWED", + "NO_MATCHING_NAT64_GATEWAY", + "LOAD_BALANCER_BACKEND_IP_VERSION_MISMATCH" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1604,9 +1625,9 @@ "The packet does not match a policy-based VPN tunnel local selector.", "The packet does not match a policy-based VPN tunnel remote selector.", "Packet with internal destination address sent to the internet gateway.", - "Instance with only an internal IP address tries to access Google API and services, but private Google access is not enabled in the subnet.", + "Endpoint with only an internal IP address tries to access Google API and services, but Private Google Access is not enabled in the subnet or is not applicable.", "Source endpoint tries to access Google API and services through the VPN tunnel to another network, but Private Google Access needs to be enabled in the source endpoint network.", - "Instance with only an internal IP address tries to access external hosts, but Cloud NAT is not enabled in the subnet, unless special configurations on a VM allow this connection.", + "Endpoint with only an internal IP address tries to access external hosts, but there is no matching Cloud NAT gateway in the subnet.", "Destination internal address cannot be resolved to a known target. If this is a shared VPC scenario, verify if the service project ID is provided as test input. Otherwise, verify if the IP address is being used in the project.", "Forwarding rule's protocol and ports do not match the packet header.", "Forwarding rule does not have backends configured.", @@ -1670,7 +1691,13 @@ "Packet from the non-GCP (on-prem) or unknown GCP network is dropped due to the destination IP address not belonging to any IP prefix advertised via BGP by the Cloud Router.", "Packet from the non-GCP (on-prem) or unknown GCP network is dropped due to the destination IP address not belonging to any IP prefix included to the local traffic selector of the VPN tunnel.", "Packet from the unknown peered network is dropped due to no known route from the source network to the destination IP address.", - "Sending packets processed by the Private NAT Gateways to the Private Service Connect endpoints is not supported." + "Sending packets processed by the Private NAT Gateways to the Private Service Connect endpoints is not supported.", + "Packet is sent to the PSC port mapping service, but its destination port does not match any port mapping rules.", + "Sending packets directly to the PSC port mapping service without going through the PSC connection is not supported.", + "Packet with destination IP address within the reserved NAT64 range is dropped due to matching a route of an unsupported type.", + "Packet could be dropped because hybrid endpoint like a VPN gateway or Interconnect is not allowed to send traffic to the Internet.", + "Packet with destination IP address within the reserved NAT64 range is dropped due to no matching NAT gateway in the subnet.", + "Packet is dropped due to being sent to a backend of a passthrough load balancer that doesn't use the same IP version as the frontend." ], "type": "string" }, @@ -1720,22 +1747,22 @@ }, "appEngineVersion": { "$ref": "AppEngineVersionEndpoint", - "description": "An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions)." + "description": "An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions). Applicable only to source endpoint." }, "cloudFunction": { "$ref": "CloudFunctionEndpoint", - "description": "A [Cloud Function](https://cloud.google.com/functions)." + "description": "A [Cloud Function](https://cloud.google.com/functions). Applicable only to source endpoint." }, "cloudRunRevision": { "$ref": "CloudRunRevisionEndpoint", - "description": "A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get)" + "description": "A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint." }, "cloudSqlInstance": { "description": "A [Cloud SQL](https://cloud.google.com/sql) instance URI.", "type": "string" }, "forwardingRule": { - "description": "A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Format: projects/{project}/global/forwardingRules/{id} or projects/{project}/regions/{region}/forwardingRules/{id}", + "description": "A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: projects/{project}/global/forwardingRules/{id} or projects/{project}/regions/{region}/forwardingRules/{id}", "type": "string" }, "forwardingRuleTarget": { @@ -1810,7 +1837,7 @@ "type": "string" }, "network": { - "description": "A Compute Engine network URI.", + "description": "A VPC network URI.", "type": "string" }, "networkType": { @@ -1823,7 +1850,7 @@ "enumDescriptions": [ "Default type if unspecified.", "A network hosted within Google Cloud. To receive more detailed output, specify the URI for the source or destination network.", - "A network hosted outside of Google Cloud. This can be an on-premises network, or a network hosted by another cloud provider." + "A network hosted outside of Google Cloud. This can be an on-premises network, an internet resource or a network hosted by another cloud provider." ], "type": "string" }, @@ -1833,15 +1860,15 @@ "type": "integer" }, "projectId": { - "description": "Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.", + "description": "Project ID where the endpoint is located. The project ID can be derived from the URI if you provide a endpoint or network URI. The following are two cases where you may need to provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.", "type": "string" }, "redisCluster": { - "description": "A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI.", + "description": "A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. Applicable only to destination endpoint.", "type": "string" }, "redisInstance": { - "description": "A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI.", + "description": "A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. Applicable only to destination endpoint.", "type": "string" } }, @@ -2139,7 +2166,8 @@ "CLOUD_DNS", "GOOGLE_API", "GOOGLE_API_PSC", - "GOOGLE_API_VPC_SC" + "GOOGLE_API_VPC_SC", + "SERVERLESS_VPC_ACCESS" ], "enumDescriptions": [ "Unspecified Google Service.", @@ -2148,7 +2176,8 @@ "Connectivity from Cloud DNS to forwarding targets or alternate name servers that use private routing. https://cloud.google.com/dns/docs/zones/forwarding-zones#firewall-rules https://cloud.google.com/dns/docs/policies#firewall-rules", "private.googleapis.com and restricted.googleapis.com", "Google API via Private Service Connect. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis", - "Google API via VPC Service Controls. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis" + "Google API via VPC Service Controls. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis", + "Google API via Serverless VPC Access. https://cloud.google.com/vpc/docs/serverless-vpc-access" ], "type": "string" }, @@ -2194,6 +2223,10 @@ "description": "URI of the PSC network attachment the NIC is attached to (if relevant).", "type": "string" }, + "running": { + "description": "Indicates whether the Compute Engine instance is running.", + "type": "boolean" + }, "serviceAccount": { "deprecated": true, "description": "Service account authorized for the instance.", @@ -2748,7 +2781,14 @@ }, "destinationEgressLocation": { "$ref": "EdgeLocation", - "description": "The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field *must not* be used as an indication that the destination/source is part of the Google network." + "description": "The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network." + }, + "edgeResponses": { + "description": "Probing results for all edge devices.", + "items": { + "$ref": "SingleEdgeResponse" + }, + "type": "array" }, "endpointInfo": { "$ref": "EndpointInfo", @@ -2758,6 +2798,10 @@ "$ref": "Status", "description": "Details about an internal failure or the cancellation of active probing." }, + "probedAllDevices": { + "description": "Whether all relevant edge devices were probed.", + "type": "boolean" + }, "probingLatency": { "$ref": "LatencyDistribution", "description": "Latency as measured by active probing in one direction: from the source to the destination endpoint." @@ -3181,6 +3225,53 @@ }, "type": "object" }, + "SingleEdgeResponse": { + "description": "Probing results for a single edge device.", + "id": "SingleEdgeResponse", + "properties": { + "destinationEgressLocation": { + "$ref": "EdgeLocation", + "description": "The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network." + }, + "destinationRouter": { + "description": "Router name in the format '{router}.{metroshard}'. For example: pf01.aaa01, pr02.aaa01.", + "type": "string" + }, + "probingLatency": { + "$ref": "LatencyDistribution", + "description": "Latency as measured by active probing in one direction: from the source to the destination endpoint." + }, + "result": { + "description": "The overall result of active probing for this egress device.", + "enum": [ + "PROBING_RESULT_UNSPECIFIED", + "REACHABLE", + "UNREACHABLE", + "REACHABILITY_INCONSISTENT", + "UNDETERMINED" + ], + "enumDescriptions": [ + "No result was specified.", + "At least 95% of packets reached the destination.", + "No packets reached the destination.", + "Less than 95% of packets reached the destination.", + "Reachability could not be determined. Possible reasons are: * The user lacks permission to access some of the network resources required to run the test. * No valid source endpoint could be derived from the request. * An internal error occurred." + ], + "type": "string" + }, + "sentProbeCount": { + "description": "Number of probes sent.", + "format": "int32", + "type": "integer" + }, + "successfulProbeCount": { + "description": "Number of probes that reached the destination.", + "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", @@ -3627,7 +3718,7 @@ "type": "string" }, "state": { - "description": "Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.", + "description": "Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.", "enum": [ "STATE_UNSPECIFIED", "ENABLED", diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index 23a5a869c32..4b21bbe997e 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -1077,6 +1077,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2750,18 +2756,18 @@ } } }, - "mirroringDeploymentGroups": { + "interceptDeploymentGroups": { "methods": { "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", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups", "httpMethod": "POST", - "id": "networksecurity.projects.locations.mirroringDeploymentGroups.create", + "id": "networksecurity.projects.locations.interceptDeploymentGroups.create", "parameterOrder": [ "parent" ], "parameters": { - "mirroringDeploymentGroupId": { + "interceptDeploymentGroupId": { "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" @@ -2779,9 +2785,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringDeploymentGroups", + "path": "v1/{+parent}/interceptDeploymentGroups", "request": { - "$ref": "MirroringDeploymentGroup" + "$ref": "InterceptDeploymentGroup" }, "response": { "$ref": "Operation" @@ -2792,9 +2798,9 @@ }, "delete": { "description": "Deletes a deployment group. See https://google.aip.dev/135.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups/{interceptDeploymentGroupsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.mirroringDeploymentGroups.delete", + "id": "networksecurity.projects.locations.interceptDeploymentGroups.delete", "parameterOrder": [ "name" ], @@ -2802,7 +2808,7 @@ "name": { "description": "Required. The deployment group to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeploymentGroups/[^/]+$", "required": true, "type": "string" }, @@ -2822,24 +2828,24 @@ }, "get": { "description": "Gets a specific deployment group. See https://google.aip.dev/131.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups/{interceptDeploymentGroupsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringDeploymentGroups.get", + "id": "networksecurity.projects.locations.interceptDeploymentGroups.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/mirroringDeploymentGroups/{mirroring_deployment_group}", + "description": "Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/interceptDeploymentGroups/{intercept_deployment_group}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeploymentGroups/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "MirroringDeploymentGroup" + "$ref": "InterceptDeploymentGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2847,9 +2853,9 @@ }, "list": { "description": "Lists deployment groups in a given project and location. See https://google.aip.dev/132.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringDeploymentGroups.list", + "id": "networksecurity.projects.locations.interceptDeploymentGroups.list", "parameterOrder": [ "parent" ], @@ -2871,7 +2877,7 @@ "type": "integer" }, "pageToken": { - "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.", + "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" }, @@ -2883,9 +2889,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringDeploymentGroups", + "path": "v1/{+parent}/interceptDeploymentGroups", "response": { - "$ref": "ListMirroringDeploymentGroupsResponse" + "$ref": "ListInterceptDeploymentGroupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2893,17 +2899,17 @@ }, "patch": { "description": "Updates a deployment group. See https://google.aip.dev/134.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups/{interceptDeploymentGroupsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.mirroringDeploymentGroups.patch", + "id": "networksecurity.projects.locations.interceptDeploymentGroups.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.", + "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/[^/]+/mirroringDeploymentGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeploymentGroups/[^/]+$", "required": true, "type": "string" }, @@ -2913,7 +2919,7 @@ "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.", + "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" @@ -2921,7 +2927,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "MirroringDeploymentGroup" + "$ref": "InterceptDeploymentGroup" }, "response": { "$ref": "Operation" @@ -2932,18 +2938,18 @@ } } }, - "mirroringDeployments": { + "interceptDeployments": { "methods": { "create": { "description": "Creates a deployment in a given project and location. See https://google.aip.dev/133.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeployments", "httpMethod": "POST", - "id": "networksecurity.projects.locations.mirroringDeployments.create", + "id": "networksecurity.projects.locations.interceptDeployments.create", "parameterOrder": [ "parent" ], "parameters": { - "mirroringDeploymentId": { + "interceptDeploymentId": { "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" @@ -2961,9 +2967,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringDeployments", + "path": "v1/{+parent}/interceptDeployments", "request": { - "$ref": "MirroringDeployment" + "$ref": "InterceptDeployment" }, "response": { "$ref": "Operation" @@ -2974,9 +2980,9 @@ }, "delete": { "description": "Deletes a deployment. See https://google.aip.dev/135.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeployments/{interceptDeploymentsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.mirroringDeployments.delete", + "id": "networksecurity.projects.locations.interceptDeployments.delete", "parameterOrder": [ "name" ], @@ -2984,7 +2990,7 @@ "name": { "description": "Required. Name of the resource", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeployments/[^/]+$", "required": true, "type": "string" }, @@ -3004,24 +3010,24 @@ }, "get": { "description": "Gets a specific deployment. See https://google.aip.dev/131.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeployments/{interceptDeploymentsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringDeployments.get", + "id": "networksecurity.projects.locations.interceptDeployments.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}", + "description": "Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeployments/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "MirroringDeployment" + "$ref": "InterceptDeployment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -3029,9 +3035,9 @@ }, "list": { "description": "Lists deployments in a given project and location. See https://google.aip.dev/132.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeployments", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringDeployments.list", + "id": "networksecurity.projects.locations.interceptDeployments.list", "parameterOrder": [ "parent" ], @@ -3053,7 +3059,7 @@ "type": "integer" }, "pageToken": { - "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.", + "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" }, @@ -3065,9 +3071,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringDeployments", + "path": "v1/{+parent}/interceptDeployments", "response": { - "$ref": "ListMirroringDeploymentsResponse" + "$ref": "ListInterceptDeploymentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -3075,17 +3081,17 @@ }, "patch": { "description": "Updates a deployment. See https://google.aip.dev/134.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptDeployments/{interceptDeploymentsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.mirroringDeployments.patch", + "id": "networksecurity.projects.locations.interceptDeployments.patch", "parameterOrder": [ "name" ], "parameters": { "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.", + "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/[^/]+/mirroringDeployments/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeployments/[^/]+$", "required": true, "type": "string" }, @@ -3095,7 +3101,7 @@ "type": "string" }, "updateMask": { - "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.", + "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" @@ -3103,7 +3109,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "MirroringDeployment" + "$ref": "InterceptDeployment" }, "response": { "$ref": "Operation" @@ -3114,18 +3120,18 @@ } } }, - "mirroringEndpointGroupAssociations": { + "interceptEndpointGroupAssociations": { "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", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations", "httpMethod": "POST", - "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.create", + "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.create", "parameterOrder": [ "parent" ], "parameters": { - "mirroringEndpointGroupAssociationId": { + "interceptEndpointGroupAssociationId": { "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" @@ -3143,9 +3149,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringEndpointGroupAssociations", + "path": "v1/{+parent}/interceptEndpointGroupAssociations", "request": { - "$ref": "MirroringEndpointGroupAssociation" + "$ref": "InterceptEndpointGroupAssociation" }, "response": { "$ref": "Operation" @@ -3156,9 +3162,9 @@ }, "delete": { "description": "Deletes an association. See https://google.aip.dev/135.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociationsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.delete", + "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.delete", "parameterOrder": [ "name" ], @@ -3166,7 +3172,7 @@ "name": { "description": "Required. The association to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroupAssociations/[^/]+$", "required": true, "type": "string" }, @@ -3186,24 +3192,24 @@ }, "get": { "description": "Gets a specific association. See https://google.aip.dev/131.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociationsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.get", + "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroupAssociations/{mirroring_endpoint_group_association}", + "description": "Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroupAssociations/{intercept_endpoint_group_association}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroupAssociations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "MirroringEndpointGroupAssociation" + "$ref": "InterceptEndpointGroupAssociation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -3211,9 +3217,9 @@ }, "list": { "description": "Lists associations in a given project and location. See https://google.aip.dev/132.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.list", + "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.list", "parameterOrder": [ "parent" ], @@ -3235,7 +3241,7 @@ "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.", + "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" }, @@ -3247,9 +3253,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringEndpointGroupAssociations", + "path": "v1/{+parent}/interceptEndpointGroupAssociations", "response": { - "$ref": "ListMirroringEndpointGroupAssociationsResponse" + "$ref": "ListInterceptEndpointGroupAssociationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -3257,17 +3263,17 @@ }, "patch": { "description": "Updates an association. See https://google.aip.dev/134.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociationsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.patch", + "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.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.", + "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/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroupAssociations/[^/]+$", "required": true, "type": "string" }, @@ -3277,7 +3283,7 @@ "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.", + "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" @@ -3285,7 +3291,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "MirroringEndpointGroupAssociation" + "$ref": "InterceptEndpointGroupAssociation" }, "response": { "$ref": "Operation" @@ -3296,18 +3302,18 @@ } } }, - "mirroringEndpointGroups": { + "interceptEndpointGroups": { "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", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups", "httpMethod": "POST", - "id": "networksecurity.projects.locations.mirroringEndpointGroups.create", + "id": "networksecurity.projects.locations.interceptEndpointGroups.create", "parameterOrder": [ "parent" ], "parameters": { - "mirroringEndpointGroupId": { + "interceptEndpointGroupId": { "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" @@ -3325,9 +3331,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringEndpointGroups", + "path": "v1/{+parent}/interceptEndpointGroups", "request": { - "$ref": "MirroringEndpointGroup" + "$ref": "InterceptEndpointGroup" }, "response": { "$ref": "Operation" @@ -3338,9 +3344,9 @@ }, "delete": { "description": "Deletes an endpoint group. See https://google.aip.dev/135.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups/{interceptEndpointGroupsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.mirroringEndpointGroups.delete", + "id": "networksecurity.projects.locations.interceptEndpointGroups.delete", "parameterOrder": [ "name" ], @@ -3348,7 +3354,7 @@ "name": { "description": "Required. The endpoint group to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroups/[^/]+$", "required": true, "type": "string" }, @@ -3368,24 +3374,24 @@ }, "get": { "description": "Gets a specific endpoint group. See https://google.aip.dev/131.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups/{interceptEndpointGroupsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringEndpointGroups.get", + "id": "networksecurity.projects.locations.interceptEndpointGroups.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroring_endpoint_group}", + "description": "Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroups/{intercept_endpoint_group}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroups/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "MirroringEndpointGroup" + "$ref": "InterceptEndpointGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -3393,9 +3399,9 @@ }, "list": { "description": "Lists endpoint groups in a given project and location. See https://google.aip.dev/132.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups", "httpMethod": "GET", - "id": "networksecurity.projects.locations.mirroringEndpointGroups.list", + "id": "networksecurity.projects.locations.interceptEndpointGroups.list", "parameterOrder": [ "parent" ], @@ -3417,7 +3423,7 @@ "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.", + "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" }, @@ -3429,9 +3435,9 @@ "type": "string" } }, - "path": "v1/{+parent}/mirroringEndpointGroups", + "path": "v1/{+parent}/interceptEndpointGroups", "response": { - "$ref": "ListMirroringEndpointGroupsResponse" + "$ref": "ListInterceptEndpointGroupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -3439,17 +3445,17 @@ }, "patch": { "description": "Updates an endpoint group. See https://google.aip.dev/134.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups/{interceptEndpointGroupsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.mirroringEndpointGroups.patch", + "id": "networksecurity.projects.locations.interceptEndpointGroups.patch", "parameterOrder": [ "name" ], "parameters": { "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.", + "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/[^/]+/mirroringEndpointGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroups/[^/]+$", "required": true, "type": "string" }, @@ -3459,7 +3465,7 @@ "type": "string" }, "updateMask": { - "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.", + "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" @@ -3467,7 +3473,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "MirroringEndpointGroup" + "$ref": "InterceptEndpointGroup" }, "response": { "$ref": "Operation" @@ -3478,304 +3484,352 @@ } } }, - "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" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "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": [ - "parent" - ], - "parameters": { + }, "parent": { - "description": "Required. The parent resource of the ServerTlsPolicy. Must be in the format `projects/*/locations/{location}`.", + "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" - }, - "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" - }, + "path": "v1/{+parent}/mirroringDeploymentGroups", "response": { - "$ref": "Operation" + "$ref": "ListMirroringDeploymentGroupsResponse" }, "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", + "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": "Required. A name of the ServerTlsPolicy to delete. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", + "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/[^/]+/serverTlsPolicies/[^/]+$", + "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}", + "request": { + "$ref": "MirroringDeploymentGroup" + }, "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", + } + } + }, + "mirroringDeployments": { + "methods": { + "create": { + "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.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 where this deployment 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}/mirroringDeployments", + "request": { + "$ref": "MirroringDeployment" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a deployment. See https://google.aip.dev/135.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.mirroringDeployments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the ServerTlsPolicy to get. 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}", "response": { - "$ref": "ServerTlsPolicy" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}:getIamPolicy", + "get": { + "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.getIamPolicy", + "id": "networksecurity.projects.locations.mirroringDeployments.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. 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/{+resource}:getIamPolicy", + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "MirroringDeployment" }, "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", + "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.list", + "id": "networksecurity.projects.locations.mirroringDeployments.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 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" - }, - "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", + "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" @@ -3783,7 +3837,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "ServerTlsPolicy" + "$ref": "MirroringDeployment" }, "response": { "$ref": "Operation" @@ -3791,92 +3845,41 @@ "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": { + "mirroringEndpointGroupAssociations": { "methods": { "create": { - "description": "Creates a new TlsInspectionPolicy in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies", + "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.tlsInspectionPolicies.create", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.create", "parameterOrder": [ "parent" ], "parameters": { + "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 of the TlsInspectionPolicy. Must be in the format `projects/{project}/locations/{location}`.", + "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" }, - "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" } }, - "path": "v1/{+parent}/tlsInspectionPolicies", + "path": "v1/{+parent}/mirroringEndpointGroupAssociations", "request": { - "$ref": "TlsInspectionPolicy" + "$ref": "MirroringEndpointGroupAssociation" }, "response": { "$ref": "Operation" @@ -3886,25 +3889,25 @@ ] }, "delete": { - "description": "Deletes a single TlsInspectionPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "description": "Deletes an association. See https://google.aip.dev/135.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.tlsInspectionPolicies.delete", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.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 association to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "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/{+name}", @@ -3916,84 +3919,99 @@ ] }, "get": { - "description": "Gets details of a single TlsInspectionPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "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.tlsInspectionPolicies.get", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.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 association to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroupAssociations/{mirroring_endpoint_group_association}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "TlsInspectionPolicy" + "$ref": "MirroringEndpointGroupAssociation" }, "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 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.tlsInspectionPolicies.list", + "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": "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 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}/tlsInspectionPolicies", + "path": "v1/{+parent}/mirroringEndpointGroupAssociations", "response": { - "$ref": "ListTlsInspectionPoliciesResponse" + "$ref": "ListMirroringEndpointGroupAssociationsResponse" }, "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 association. See https://google.aip.dev/134.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.tlsInspectionPolicies.patch", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.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 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/[^/]+/tlsInspectionPolicies/[^/]+$", + "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" + }, "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 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" @@ -4001,7 +4019,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "TlsInspectionPolicy" + "$ref": "MirroringEndpointGroupAssociation" }, "response": { "$ref": "Operation" @@ -4012,33 +4030,38 @@ } } }, - "urlLists": { + "mirroringEndpointGroups": { "methods": { "create": { - "description": "Creates a new UrlList in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists", + "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.urlLists.create", + "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 of the UrlList. Must be in the format `projects/*/locations/{location}`.", + "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" }, - "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\".", + "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}/urlLists", + "path": "v1/{+parent}/mirroringEndpointGroups", "request": { - "$ref": "UrlList" + "$ref": "MirroringEndpointGroup" }, "response": { "$ref": "Operation" @@ -4048,20 +4071,25 @@ ] }, "delete": { - "description": "Deletes a single UrlList.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", + "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.urlLists.delete", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the UrlList to delete. Must be in the format `projects/*/locations/{location}/urlLists/*`.", + "description": "Required. The endpoint group to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", + "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}", @@ -4073,84 +4101,99 @@ ] }, "get": { - "description": "Gets details of a single UrlList.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", + "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.urlLists.get", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the UrlList to get. Must be in the format `projects/*/locations/{location}/urlLists/*`.", + "description": "Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroring_endpoint_group}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "UrlList" + "$ref": "MirroringEndpointGroup" }, "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 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.urlLists.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 UrlLists 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 `ListUrlListsResponse` Indicates that this is a continuation of a prior `ListUrlLists` 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 UrlLists 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}/urlLists", + "path": "v1/{+parent}/mirroringEndpointGroups", "response": { - "$ref": "ListUrlListsResponse" + "$ref": "ListMirroringEndpointGroupsResponse" }, "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}", + "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.urlLists.patch", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.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])?$).", + "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/[^/]+/urlLists/[^/]+$", + "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 UrlList 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" @@ -4158,7 +4201,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "UrlList" + "$ref": "MirroringEndpointGroup" }, "response": { "$ref": "Operation" @@ -4168,129 +4211,820 @@ ] } } - } - } - } - } - } - }, - "revision": "20250310", - "rootUrl": "https://networksecurity.googleapis.com/", - "schemas": { - "AddAddressGroupItemsRequest": { - "description": "Request used by the AddAddressGroupItems method.", - "id": "AddAddressGroupItemsRequest", - "properties": { - "items": { - "description": "Required. List of items to add.", - "items": { - "type": "string" - }, - "type": "array" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "type": "string" - } - }, - "type": "object" - }, - "AddressGroup": { - "description": "AddressGroup is a resource that specifies how a collection of IP/DNS used in Firewall Policy.", - "id": "AddressGroup", - "properties": { - "capacity": { - "description": "Required. Capacity of the Address Group", - "format": "int32", - "type": "integer" - }, - "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" - }, - "items": { - "description": "Optional. List of items.", - "items": { - "type": "string" - }, - "type": "array" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Set of label tags associated with the AddressGroup resource.", - "type": "object" - }, - "name": { - "description": "Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.", - "type": "string" - }, - "purpose": { - "description": "Optional. List of supported purposes of the Address Group.", - "items": { - "enum": [ - "PURPOSE_UNSPECIFIED", - "DEFAULT", - "CLOUD_ARMOR" - ], - "enumDescriptions": [ - "Default value. Should never happen.", - "Address Group is distributed to VMC, and is usable in Firewall Policies and other systems that rely on VMC.", - "Address Group is usable in Cloud Armor." - ], - "type": "string" - }, - "type": "array" - }, - "selfLink": { - "description": "Output only. Server-defined fully-qualified URL for this resource.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "Required. The type of the Address Group. Possible values are \"IPv4\" or \"IPV6\".", - "enum": [ - "TYPE_UNSPECIFIED", - "IPV4", - "IPV6" - ], - "enumDescriptions": [ - "Default value.", - "IP v4 ranges.", - "IP v6 ranges." - ], - "type": "string" - }, - "updateTime": { - "description": "Output only. The timestamp when the resource was updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "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": [ + }, + "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": "networksecurity.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": "networksecurity.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": "networksecurity.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": "networksecurity.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" + ] + } + } + }, + "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": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the ServerTlsPolicy. Must be in the format `projects/*/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\".", + "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" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the UrlList 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": "UrlList" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250416", + "rootUrl": "https://networksecurity.googleapis.com/", + "schemas": { + "AddAddressGroupItemsRequest": { + "description": "Request used by the AddAddressGroupItems method.", + "id": "AddAddressGroupItemsRequest", + "properties": { + "items": { + "description": "Required. List of items to add.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "AddressGroup": { + "description": "AddressGroup is a resource that specifies how a collection of IP/DNS used in Firewall Policy.", + "id": "AddressGroup", + "properties": { + "capacity": { + "description": "Required. Capacity of the Address Group", + "format": "int32", + "type": "integer" + }, + "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" + }, + "items": { + "description": "Optional. List of items.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of label tags associated with the AddressGroup resource.", + "type": "object" + }, + "name": { + "description": "Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.", + "type": "string" + }, + "purpose": { + "description": "Optional. List of supported purposes of the Address Group.", + "items": { + "enum": [ + "PURPOSE_UNSPECIFIED", + "DEFAULT", + "CLOUD_ARMOR" + ], + "enumDescriptions": [ + "Default value. Should never happen.", + "Address Group is distributed to VMC, and is usable in Firewall Policies and other systems that rely on VMC.", + "Address Group is usable in Cloud Armor." + ], + "type": "string" + }, + "type": "array" + }, + "selfLink": { + "description": "Output only. Server-defined fully-qualified URL for this resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Required. The type of the Address Group. Possible values are \"IPv4\" or \"IPV6\".", + "enum": [ + "TYPE_UNSPECIFIED", + "IPV4", + "IPV6" + ], + "enumDescriptions": [ + "Default value.", + "IP v4 ranges.", + "IP v6 ranges." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "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.", @@ -4313,7 +5047,7 @@ ], "enumDescriptions": [ "Protocol not specified.", - "SMTP prtocol", + "SMTP protocol", "SMB protocol", "POP3 protocol", "IMAP protocol", @@ -4326,116 +5060,447 @@ }, "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", + "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", + "properties": { + "action": { + "description": "Required. The action to take when a rule match is found. Possible values are \"ALLOW\" or \"DENY\".", + "enum": [ + "ACTION_UNSPECIFIED", + "ALLOW", + "DENY" + ], + "enumDescriptions": [ + "Default value.", + "Grant access.", + "Deny access. Deny rules should be avoided unless they are used to provide a default \"deny all\" fallback." + ], + "type": "string" + }, + "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 AuthorizationPolicy resource.", + "type": "object" + }, + "name": { + "description": "Required. Name of the AuthorizationPolicy resource. It matches pattern `projects/{project}/locations/{location}/authorizationPolicies/`.", + "type": "string" + }, + "rules": { + "description": "Optional. List of rules to match. Note that at least one of the rules must match in order for the action specified in the 'action' field to be taken. A rule is a match if there is a matching source and destination. If left blank, the action specified in the `action` field will be applied on every request.", + "items": { + "$ref": "Rule" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AuthzPolicy": { + "description": "`AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.", + "id": "AuthzPolicy", + "properties": { + "action": { + "description": "Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`. When the action is `CUSTOM`, `customProvider` must be specified. When the action is `ALLOW`, only requests matching the policy will be allowed. When the action is `DENY`, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a `CUSTOM` policy that matches the request, the `CUSTOM` policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any `DENY` policies that match the request, the request is denied. 3. If there are no `ALLOW` policies for the resource or if any of the `ALLOW` policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with `ALLOW` action match the request.", + "enum": [ + "AUTHZ_ACTION_UNSPECIFIED", + "ALLOW", + "DENY", + "CUSTOM" + ], + "enumDescriptions": [ + "Unspecified action.", + "Allow request to pass through to the backend.", + "Deny the request and return a HTTP 404 to the client.", + "Delegate the authorization decision to an external authorization engine." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customProvider": { + "$ref": "AuthzPolicyCustomProvider", + "description": "Optional. Required if the action is `CUSTOM`. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of `cloudIap` or `authzExtension` must be specified." + }, + "description": { + "description": "Optional. A human-readable description of the resource.", + "type": "string" + }, + "httpRules": { + "description": "Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.", + "items": { + "$ref": "AuthzPolicyAuthzRule" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", + "type": "object" + }, + "name": { + "description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", + "type": "string" + }, + "target": { + "$ref": "AuthzPolicyTarget", + "description": "Required. Specifies the set of resources to which this policy should be applied to." + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRule": { + "description": "Conditions to match against the incoming request.", + "id": "AuthzPolicyAuthzRule", + "properties": { + "from": { + "$ref": "AuthzPolicyAuthzRuleFrom", + "description": "Optional. Describes properties of a source of a request." + }, + "to": { + "$ref": "AuthzPolicyAuthzRuleTo", + "description": "Optional. Describes properties of a target of a request." + }, + "when": { + "description": "Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.", + "type": "string" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleFrom": { + "description": "Describes properties of one or more sources of a request.", + "id": "AuthzPolicyAuthzRuleFrom", + "properties": { + "notSources": { + "description": "Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.", + "items": { + "$ref": "AuthzPolicyAuthzRuleFromRequestSource" + }, + "type": "array" + }, + "sources": { + "description": "Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.", + "items": { + "$ref": "AuthzPolicyAuthzRuleFromRequestSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleFromRequestSource": { + "description": "Describes the properties of a single source.", + "id": "AuthzPolicyAuthzRuleFromRequestSource", + "properties": { + "principals": { + "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the forwarding rule or Gateway. 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" + }, + "type": "array" + }, + "resources": { + "description": "Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources.", + "items": { + "$ref": "AuthzPolicyAuthzRuleRequestResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleHeaderMatch": { + "description": "Determines how a HTTP header should be matched.", + "id": "AuthzPolicyAuthzRuleHeaderMatch", + "properties": { + "name": { + "description": "Optional. Specifies the name of the header in the request.", + "type": "string" + }, + "value": { + "$ref": "AuthzPolicyAuthzRuleStringMatch", + "description": "Optional. Specifies how the header match will be performed." + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleRequestResource": { + "description": "Describes the properties of a client VM resource accessing the internal application load balancers.", + "id": "AuthzPolicyAuthzRuleRequestResource", "properties": { - "action": { - "description": "Required. The action to take when a rule match is found. Possible values are \"ALLOW\" or \"DENY\".", - "enum": [ - "ACTION_UNSPECIFIED", - "ALLOW", - "DENY" - ], - "enumDescriptions": [ - "Default value.", - "Grant access.", - "Deny access. Deny rules should be avoided unless they are used to provide a default \"deny all\" fallback." - ], + "iamServiceAccount": { + "$ref": "AuthzPolicyAuthzRuleStringMatch", + "description": "Optional. An IAM service account to match against the source service account of the VM sending the request." + }, + "tagValueIdSet": { + "$ref": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", + "description": "Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request." + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet": { + "description": "Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.", + "id": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", + "properties": { + "ids": { + "description": "Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 matches.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleStringMatch": { + "description": "Determines how a string value should be matched.", + "id": "AuthzPolicyAuthzRuleStringMatch", + "properties": { + "contains": { + "description": "The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``", "type": "string" }, - "createTime": { - "description": "Output only. The timestamp when the resource was created.", - "format": "google-datetime", - "readOnly": true, + "exact": { + "description": "The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.", "type": "string" }, - "description": { - "description": "Optional. Free-text description of the resource.", + "ignoreCase": { + "description": "If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.", + "type": "boolean" + }, + "prefix": { + "description": "The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" + "suffix": { + "description": "The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``", + "type": "string" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleTo": { + "description": "Describes properties of one or more targets of a request.", + "id": "AuthzPolicyAuthzRuleTo", + "properties": { + "notOperations": { + "description": "Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.", + "items": { + "$ref": "AuthzPolicyAuthzRuleToRequestOperation" }, - "description": "Optional. Set of label tags associated with the AuthorizationPolicy resource.", - "type": "object" + "type": "array" }, - "name": { - "description": "Required. Name of the AuthorizationPolicy resource. It matches pattern `projects/{project}/locations/{location}/authorizationPolicies/`.", - "type": "string" + "operations": { + "description": "Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.", + "items": { + "$ref": "AuthzPolicyAuthzRuleToRequestOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleToRequestOperation": { + "description": "Describes properties of one or more targets of a request.", + "id": "AuthzPolicyAuthzRuleToRequestOperation", + "properties": { + "headerSet": { + "$ref": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", + "description": "Optional. A list of headers to match against in http header." }, - "rules": { - "description": "Optional. List of rules to match. Note that at least one of the rules must match in order for the action specified in the 'action' field to be taken. A rule is a match if there is a matching source and destination. If left blank, the action specified in the `action` field will be applied on every request.", + "hosts": { + "description": "Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 5 matches.", "items": { - "$ref": "Rule" + "$ref": "AuthzPolicyAuthzRuleStringMatch" }, "type": "array" }, - "updateTime": { - "description": "Output only. The timestamp when the resource was updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "methods": { + "description": "Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.", + "items": { + "type": "string" + }, + "type": "array" + }, + "paths": { + "description": "Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 5 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.", + "items": { + "$ref": "AuthzPolicyAuthzRuleStringMatch" + }, + "type": "array" } }, "type": "object" }, - "AuthzPolicy": { - "description": "`AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.", - "id": "AuthzPolicy", + "AuthzPolicyAuthzRuleToRequestOperationHeaderSet": { + "description": "Describes a set of HTTP headers to match against.", + "id": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", "properties": { - "action": { - "description": "Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`. When the action is `CUSTOM`, `customProvider` must be specified. When the action is `ALLOW`, only requests matching the policy will be allowed. When the action is `DENY`, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a `CUSTOM` policy that matches the request, the `CUSTOM` policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any `DENY` policies that match the request, the request is denied. 3. If there are no `ALLOW` policies for the resource or if any of the `ALLOW` policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with `ALLOW` action match the request.", + "headers": { + "description": "Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 5 matches.", + "items": { + "$ref": "AuthzPolicyAuthzRuleHeaderMatch" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyCustomProvider": { + "description": "Allows delegating authorization decisions to Cloud IAP or to Service Extensions.", + "id": "AuthzPolicyCustomProvider", + "properties": { + "authzExtension": { + "$ref": "AuthzPolicyCustomProviderAuthzExtension", + "description": "Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified." + }, + "cloudIap": { + "$ref": "AuthzPolicyCustomProviderCloudIap", + "description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places." + } + }, + "type": "object" + }, + "AuthzPolicyCustomProviderAuthzExtension": { + "description": "Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified.", + "id": "AuthzPolicyCustomProviderAuthzExtension", + "properties": { + "resources": { + "description": "Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyCustomProviderCloudIap": { + "description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.", + "id": "AuthzPolicyCustomProviderCloudIap", + "properties": {}, + "type": "object" + }, + "AuthzPolicyTarget": { + "description": "Specifies the set of targets to which this policy should be applied to.", + "id": "AuthzPolicyTarget", + "properties": { + "loadBalancingScheme": { + "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ - "AUTHZ_ACTION_UNSPECIFIED", - "ALLOW", - "DENY", - "CUSTOM" + "LOAD_BALANCING_SCHEME_UNSPECIFIED", + "INTERNAL_MANAGED", + "EXTERNAL_MANAGED", + "INTERNAL_SELF_MANAGED" ], "enumDescriptions": [ - "Unspecified action.", - "Allow request to pass through to the backend.", - "Deny the request and return a HTTP 404 to the client.", - "Delegate the authorization decision to an external authorization engine." + "Default value. Do not use.", + "Signifies that this is used for Regional internal or Cross-region internal Application Load Balancing.", + "Signifies that this is used for Global external or Regional external Application Load Balancing.", + "Signifies that this is used for Cloud Service Mesh. Meant for use by CSM GKE controller only." ], "type": "string" }, + "resources": { + "description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "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": "GoogleCloudNetworksecurityV1CertificateProvider", + "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" }, - "customProvider": { - "$ref": "AuthzPolicyCustomProvider", - "description": "Optional. Required if the action is `CUSTOM`. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of `cloudIap` or `authzExtension` must be specified." - }, "description": { - "description": "Optional. A human-readable description of the resource.", + "description": "Optional. Free-text description of the resource.", "type": "string" }, - "httpRules": { - "description": "Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.", - "items": { - "$ref": "AuthzPolicyAuthzRule" - }, - "type": "array" - }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", + "description": "Optional. Set of label tags associated with the resource.", "type": "object" }, "name": { - "description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", + "description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", "type": "string" }, - "target": { - "$ref": "AuthzPolicyTarget", - "description": "Required. Specifies the set of resources to which this policy should be applied to." + "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" + }, + "type": "array" + }, + "sni": { + "description": "Optional. Server Name Indication string to present to the server during TLS handshake. E.g: \"secure.example.com\".", + "type": "string" }, "updateTime": { "description": "Output only. The timestamp when the resource was updated.", @@ -4446,298 +5511,338 @@ }, "type": "object" }, - "AuthzPolicyAuthzRule": { - "description": "Conditions to match against the incoming request.", - "id": "AuthzPolicyAuthzRule", + "CloneAddressGroupItemsRequest": { + "description": "Request used by the CloneAddressGroupItems method.", + "id": "CloneAddressGroupItemsRequest", "properties": { - "from": { - "$ref": "AuthzPolicyAuthzRuleFrom", - "description": "Optional. Describes properties of a source of a request." - }, - "to": { - "$ref": "AuthzPolicyAuthzRuleTo", - "description": "Optional. Describes properties of a target of a request." + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" }, - "when": { - "description": "Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.", + "sourceAddressGroup": { + "description": "Required. Source address group to clone items from.", "type": "string" } }, "type": "object" }, - "AuthzPolicyAuthzRuleFrom": { - "description": "Describes properties of one or more sources of a request.", - "id": "AuthzPolicyAuthzRuleFrom", + "CustomInterceptProfile": { + "description": "CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action.", + "id": "CustomInterceptProfile", "properties": { - "notSources": { - "description": "Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.", - "items": { - "$ref": "AuthzPolicyAuthzRuleFromRequestSource" - }, - "type": "array" - }, - "sources": { - "description": "Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.", - "items": { - "$ref": "AuthzPolicyAuthzRuleFromRequestSource" - }, - "type": "array" + "interceptEndpointGroup": { + "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" }, - "AuthzPolicyAuthzRuleFromRequestSource": { - "description": "Describes the properties of a single source.", - "id": "AuthzPolicyAuthzRuleFromRequestSource", + "CustomMirroringProfile": { + "description": "CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action.", + "id": "CustomMirroringProfile", "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. 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.", + "mirroringEndpointGroup": { + "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" + } + }, + "type": "object" + }, + "Destination": { + "description": "Specification of traffic destination attributes.", + "id": "Destination", + "properties": { + "hosts": { + "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example \"*.myorg.com\") or a presence (any) match \"*\".", "items": { - "$ref": "AuthzPolicyAuthzRuleStringMatch" + "type": "string" }, "type": "array" }, - "resources": { - "description": "Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources.", + "httpHeaderMatch": { + "$ref": "HttpHeaderMatch", + "description": "Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy." + }, + "methods": { + "description": "Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.", "items": { - "$ref": "AuthzPolicyAuthzRuleRequestResource" + "type": "string" + }, + "type": "array" + }, + "ports": { + "description": "Required. List of destination ports to match. At least one port should match.", + "items": { + "format": "uint32", + "type": "integer" }, "type": "array" } }, "type": "object" }, - "AuthzPolicyAuthzRuleHeaderMatch": { - "description": "Determines how a HTTP header should be matched.", - "id": "AuthzPolicyAuthzRuleHeaderMatch", - "properties": { - "name": { - "description": "Optional. Specifies the name of the header in the request.", - "type": "string" - }, - "value": { - "$ref": "AuthzPolicyAuthzRuleStringMatch", - "description": "Optional. Specifies how the header match will be performed." - } - }, + "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" }, - "AuthzPolicyAuthzRuleRequestResource": { - "description": "Describes the properties of a client VM resource accessing the internal application load balancers.", - "id": "AuthzPolicyAuthzRuleRequestResource", + "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": { - "iamServiceAccount": { - "$ref": "AuthzPolicyAuthzRuleStringMatch", - "description": "Optional. An IAM service account to match against the source service account of the VM sending the request." + "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" }, - "tagValueIdSet": { - "$ref": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", - "description": "Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request." + "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" }, - "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet": { - "description": "Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.", - "id": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", + "FirewallEndpoint": { + "description": "Message describing Endpoint object", + "id": "FirewallEndpoint", "properties": { - "ids": { - "description": "Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 matches.", + "associatedNetworks": { + "deprecated": true, + "description": "Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.", "items": { - "format": "int64", "type": "string" }, + "readOnly": true, + "type": "array" + }, + "associations": { + "description": "Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.", + "items": { + "$ref": "FirewallEndpointAssociationReference" + }, + "readOnly": true, "type": "array" + }, + "billingProjectId": { + "description": "Required. Project to bill on endpoint uptime usage.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the firewall endpoint. Max length 2048 characters.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. name of resource", + "type": "string" + }, + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "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": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "INACTIVE" + ], + "enumDescriptions": [ + "Not set.", + "Being created.", + "Processing configuration updates.", + "Being deleted.", + "Down or in an error state." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "AuthzPolicyAuthzRuleStringMatch": { - "description": "Determines how a string value should be matched.", - "id": "AuthzPolicyAuthzRuleStringMatch", + "FirewallEndpointAssociation": { + "description": "Message describing Association object", + "id": "FirewallEndpointAssociation", "properties": { - "contains": { - "description": "The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``", + "createTime": { + "description": "Output only. Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "disabled": { + "description": "Optional. Whether the association is disabled. True indicates that traffic won't be intercepted", + "type": "boolean" + }, + "firewallEndpoint": { + "description": "Required. The URL of the FirewallEndpoint that is being associated.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. name of resource", "type": "string" }, - "exact": { - "description": "The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.", + "network": { + "description": "Required. The URL of the network that is being associated.", "type": "string" }, - "ignoreCase": { - "description": "If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.", + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "readOnly": true, "type": "boolean" }, - "prefix": { - "description": "The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``", + "state": { + "description": "Output only. Current state of the association.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "INACTIVE", + "ORPHAN" + ], + "enumDescriptions": [ + "Not set.", + "Being created.", + "Active and ready for traffic.", + "Being deleted.", + "Down or in an error state.", + "The project that housed the association has been deleted." + ], + "readOnly": true, "type": "string" }, - "suffix": { - "description": "The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``", + "tlsInspectionPolicy": { + "description": "Optional. The URL of the TlsInspectionPolicy that is being associated.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Update time stamp", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "AuthzPolicyAuthzRuleTo": { - "description": "Describes properties of one or more targets of a request.", - "id": "AuthzPolicyAuthzRuleTo", + "FirewallEndpointAssociationReference": { + "description": "This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.", + "id": "FirewallEndpointAssociationReference", "properties": { - "notOperations": { - "description": "Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.", - "items": { - "$ref": "AuthzPolicyAuthzRuleToRequestOperation" - }, - "type": "array" + "name": { + "description": "Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}", + "readOnly": true, + "type": "string" }, - "operations": { - "description": "Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.", - "items": { - "$ref": "AuthzPolicyAuthzRuleToRequestOperation" - }, - "type": "array" + "network": { + "description": "Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "AuthzPolicyAuthzRuleToRequestOperation": { - "description": "Describes properties of one or more targets of a request.", - "id": "AuthzPolicyAuthzRuleToRequestOperation", + "GatewaySecurityPolicy": { + "description": "The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata.", + "id": "GatewaySecurityPolicy", "properties": { - "headerSet": { - "$ref": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", - "description": "Optional. A list of headers to match against in http header." + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "hosts": { - "description": "Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 5 matches.", - "items": { - "$ref": "AuthzPolicyAuthzRuleStringMatch" - }, - "type": "array" + "description": { + "description": "Optional. Free-text description of the resource.", + "type": "string" }, - "methods": { - "description": "Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.", - "items": { - "type": "string" - }, - "type": "array" + "name": { + "description": "Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", + "type": "string" }, - "paths": { - "description": "Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 5 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.", - "items": { - "$ref": "AuthzPolicyAuthzRuleStringMatch" - }, - "type": "array" - } - }, - "type": "object" - }, - "AuthzPolicyAuthzRuleToRequestOperationHeaderSet": { - "description": "Describes a set of HTTP headers to match against.", - "id": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", - "properties": { - "headers": { - "description": "Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 5 matches.", - "items": { - "$ref": "AuthzPolicyAuthzRuleHeaderMatch" - }, - "type": "array" - } - }, - "type": "object" - }, - "AuthzPolicyCustomProvider": { - "description": "Allows delegating authorization decisions to Cloud IAP or to Service Extensions.", - "id": "AuthzPolicyCustomProvider", - "properties": { - "authzExtension": { - "$ref": "AuthzPolicyCustomProviderAuthzExtension", - "description": "Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified." + "tlsInspectionPolicy": { + "description": "Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it.", + "type": "string" }, - "cloudIap": { - "$ref": "AuthzPolicyCustomProviderCloudIap", - "description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places." - } - }, - "type": "object" - }, - "AuthzPolicyCustomProviderAuthzExtension": { - "description": "Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified.", - "id": "AuthzPolicyCustomProviderAuthzExtension", - "properties": { - "resources": { - "description": "Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.", - "items": { - "type": "string" - }, - "type": "array" + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "AuthzPolicyCustomProviderCloudIap": { - "description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.", - "id": "AuthzPolicyCustomProviderCloudIap", - "properties": {}, - "type": "object" - }, - "AuthzPolicyTarget": { - "description": "Specifies the set of targets to which this policy should be applied to.", - "id": "AuthzPolicyTarget", + "GatewaySecurityPolicyRule": { + "description": "The GatewaySecurityPolicyRule resource is in a nested collection within a GatewaySecurityPolicy and represents a traffic matching condition and associated action to perform.", + "id": "GatewaySecurityPolicyRule", "properties": { - "loadBalancingScheme": { - "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", + "applicationMatcher": { + "description": "Optional. CEL expression for matching on L7/application level criteria.", + "type": "string" + }, + "basicProfile": { + "description": "Required. Profile which tells what the primitive action should be.", "enum": [ - "LOAD_BALANCING_SCHEME_UNSPECIFIED", - "INTERNAL_MANAGED", - "EXTERNAL_MANAGED", - "INTERNAL_SELF_MANAGED" + "BASIC_PROFILE_UNSPECIFIED", + "ALLOW", + "DENY" ], "enumDescriptions": [ - "Default value. Do not use.", - "Signifies that this is used for Regional internal or Cross-region internal Application Load Balancing.", - "Signifies that this is used for Global external or Regional external Application Load Balancing.", - "Signifies that this is used for Cloud Service Mesh. Meant for use by CSM GKE controller only." + "If there is not a mentioned action for the target.", + "Allow the matched traffic.", + "Deny the matched traffic." ], "type": "string" }, - "resources": { - "description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "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": "GoogleCloudNetworksecurityV1CertificateProvider", - "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.", + "description": "Output only. Time when the rule was created.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4746,30 +5851,29 @@ "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" + "enabled": { + "description": "Required. Whether the rule is enforced.", + "type": "boolean" }, "name": { - "description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", + "description": "Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", "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" - }, - "type": "array" + "priority": { + "description": "Required. Priority of the rule. Lower number corresponds to higher precedence.", + "format": "int32", + "type": "integer" }, - "sni": { - "description": "Optional. Server Name Indication string to present to the server during TLS handshake. E.g: \"secure.example.com\".", + "sessionMatcher": { + "description": "Required. CEL expression for matching on session criteria.", "type": "string" }, + "tlsInspectionEnabled": { + "description": "Optional. Flag to enable TLS inspection of traffic matching on , can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig.", + "type": "boolean" + }, "updateTime": { - "description": "Output only. The timestamp when the resource was updated.", + "description": "Output only. Time when the rule was updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4777,187 +5881,253 @@ }, "type": "object" }, - "CloneAddressGroupItemsRequest": { - "description": "Request used by the CloneAddressGroupItems method.", - "id": "CloneAddressGroupItemsRequest", + "GoogleCloudNetworksecurityV1CertificateProvider": { + "description": "Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication.", + "id": "GoogleCloudNetworksecurityV1CertificateProvider", "properties": { - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "type": "string" + "certificateProviderInstance": { + "$ref": "CertificateProviderInstance", + "description": "The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information." }, - "sourceAddressGroup": { - "description": "Required. Source address group to clone items from.", - "type": "string" + "grpcEndpoint": { + "$ref": "GoogleCloudNetworksecurityV1GrpcEndpoint", + "description": "gRPC specific configuration to access the gRPC server to obtain the cert and private key." } }, "type": "object" }, - "CustomInterceptProfile": { - "description": "CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action.", - "id": "CustomInterceptProfile", + "GoogleCloudNetworksecurityV1GrpcEndpoint": { + "description": "Specification of the GRPC Endpoint.", + "id": "GoogleCloudNetworksecurityV1GrpcEndpoint", "properties": { - "interceptEndpointGroup": { - "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.", + "targetUri": { + "description": "Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with \"unix:\".", "type": "string" } }, "type": "object" }, - "CustomMirroringProfile": { - "description": "CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action.", - "id": "CustomMirroringProfile", + "GoogleIamV1AuditConfig": { + "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": "GoogleIamV1AuditConfig", "properties": { - "mirroringEndpointGroup": { - "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.", + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "GoogleIamV1AuditLogConfig" + }, + "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" }, - "Destination": { - "description": "Specification of traffic destination attributes.", - "id": "Destination", + "GoogleIamV1AuditLogConfig": { + "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": "GoogleIamV1AuditLogConfig", "properties": { - "hosts": { - "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example \"*.myorg.com\") or a presence (any) match \"*\".", + "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" }, - "httpHeaderMatch": { - "$ref": "HttpHeaderMatch", - "description": "Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy." + "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" + }, + "GoogleIamV1Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "GoogleIamV1Binding", + "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)." }, - "methods": { - "description": "Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.", + "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" }, - "ports": { - "description": "Required. List of destination ports to match. At least one port should match.", - "items": { - "format": "uint32", - "type": "integer" - }, - "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" }, - "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", - "id": "Expr", + "GoogleIamV1Policy": { + "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": "GoogleIamV1Policy", "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" + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "GoogleIamV1AuditConfig" + }, + "type": "array" }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" + "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": "GoogleIamV1Binding" + }, + "type": "array" }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "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" }, - "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.", + "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" + }, + "GoogleIamV1SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "GoogleIamV1SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "GoogleIamV1Policy", + "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" }, - "FirewallEndpoint": { - "description": "Message describing Endpoint object", - "id": "FirewallEndpoint", + "GoogleIamV1TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "GoogleIamV1TestIamPermissionsRequest", "properties": { - "associatedNetworks": { - "deprecated": true, - "description": "Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.", + "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" }, - "readOnly": true, "type": "array" - }, - "associations": { - "description": "Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.", + } + }, + "type": "object" + }, + "GoogleIamV1TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "GoogleIamV1TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { - "$ref": "FirewallEndpointAssociationReference" + "type": "string" }, - "readOnly": true, "type": "array" - }, - "billingProjectId": { - "description": "Required. Project to bill on endpoint uptime usage.", + } + }, + "type": "object" + }, + "HttpHeaderMatch": { + "description": "Specification of HTTP header match attributes.", + "id": "HttpHeaderMatch", + "properties": { + "headerName": { + "description": "Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\".", "type": "string" }, + "regexMatch": { + "description": "Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier.", + "type": "string" + } + }, + "type": "object" + }, + "InterceptDeployment": { + "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. 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. Description of the firewall endpoint. Max length 2048 characters.", + "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 interceptors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124.", + "type": "string" + }, + "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. name of resource", + "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.", - "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.", + "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 endpoint.", + "description": "Output only. The current state of the deployment. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", - "CREATING", "ACTIVE", + "CREATING", "DELETING", - "INACTIVE" + "OUT_OF_SYNC", + "DELETE_FAILED" ], "enumDescriptions": [ - "Not set.", - "Being created.", - "Processing configuration updates.", - "Being deleted.", - "Down or in an error state." + "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. 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" @@ -4965,71 +6135,84 @@ }, "type": "object" }, - "FirewallEndpointAssociation": { - "description": "Message describing Association object", - "id": "FirewallEndpointAssociation", + "InterceptDeploymentGroup": { + "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 endpoint groups that are connected to this resource.", + "items": { + "$ref": "InterceptDeploymentGroupConnectedEndpointGroup" + }, + "readOnly": true, + "type": "array" + }, "createTime": { - "description": "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" }, - "disabled": { - "description": "Optional. Whether the association is disabled. True indicates that traffic won't be intercepted", - "type": "boolean" - }, - "firewallEndpoint": { - "description": "Required. The URL of the FirewallEndpoint that is being associated.", + "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": "InterceptLocation" + }, + "readOnly": true, + "type": "array" + }, "name": { - "description": "Immutable. Identifier. name of resource", + "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. The URL of the network that is being associated.", + "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 association.", + "description": "Output only. The current state of the deployment group. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", - "CREATING", "ACTIVE", - "DELETING", - "INACTIVE", - "ORPHAN" + "CREATING", + "DELETING" ], "enumDescriptions": [ - "Not set.", - "Being created.", - "Active and ready for traffic.", - "Being deleted.", - "Down or in an error state.", - "The project that housed the association has been 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" }, - "tlsInspectionPolicy": { - "description": "Optional. The URL of the TlsInspectionPolicy that is being associated.", - "type": "string" - }, "updateTime": { - "description": "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" @@ -5037,297 +6220,322 @@ }, "type": "object" }, - "FirewallEndpointAssociationReference": { - "description": "This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.", - "id": "FirewallEndpointAssociationReference", + "InterceptDeploymentGroupConnectedEndpointGroup": { + "description": "An endpoint group connected to this deployment group.", + "id": "InterceptDeploymentGroupConnectedEndpointGroup", "properties": { "name": { - "description": "Output only. The resource name of the FirewallEndpointAssociation. Format: projects/{project}/locations/{location}/firewallEndpointAssociations/{id}", - "readOnly": true, - "type": "string" - }, - "network": { - "description": "Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.", + "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" }, - "GatewaySecurityPolicy": { - "description": "The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata.", - "id": "GatewaySecurityPolicy", + "InterceptDeploymentGroupDeployment": { + "description": "A deployment belonging to this deployment group.", + "id": "InterceptDeploymentGroupDeployment", "properties": { - "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" - }, "name": { - "description": "Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", - "type": "string" - }, - "tlsInspectionPolicy": { - "description": "Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it.", + "description": "Output only. The name of the Intercept Deployment, in the format: `projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}`.", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Output only. The timestamp when the resource was updated.", - "format": "google-datetime", + "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" }, - "GatewaySecurityPolicyRule": { - "description": "The GatewaySecurityPolicyRule resource is in a nested collection within a GatewaySecurityPolicy and represents a traffic matching condition and associated action to perform.", - "id": "GatewaySecurityPolicyRule", + "InterceptEndpointGroup": { + "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": { - "applicationMatcher": { - "description": "Optional. CEL expression for matching on L7/application level criteria.", - "type": "string" + "associations": { + "description": "Output only. List of associations to this endpoint group.", + "items": { + "$ref": "InterceptEndpointGroupAssociationDetails" + }, + "readOnly": true, + "type": "array" }, - "basicProfile": { - "description": "Required. Profile which tells what the primitive action should be.", - "enum": [ - "BASIC_PROFILE_UNSPECIFIED", - "ALLOW", - "DENY" - ], - "enumDescriptions": [ - "If there is not a mentioned action for the target.", - "Allow the matched traffic.", - "Deny the matched traffic." - ], - "type": "string" + "connectedDeploymentGroup": { + "$ref": "InterceptEndpointGroupConnectedDeploymentGroup", + "description": "Output only. Details about the connected deployment group to this endpoint group.", + "readOnly": true }, "createTime": { - "description": "Output only. Time when the rule was created.", + "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. Free-text description of the resource.", + "description": "Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.", "type": "string" }, - "enabled": { - "description": "Required. Whether the rule is enforced.", - "type": "boolean" - }, - "name": { - "description": "Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", + "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" }, - "priority": { - "description": "Required. Priority of the rule. Lower number corresponds to higher precedence.", - "format": "int32", - "type": "integer" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", + "type": "object" }, - "sessionMatcher": { - "description": "Required. CEL expression for matching on session criteria.", + "name": { + "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" }, - "tlsInspectionEnabled": { - "description": "Optional. Flag to enable TLS inspection of traffic matching on , can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig.", - "type": "boolean" - }, - "updateTime": { - "description": "Output only. Time when the rule was updated.", - "format": "google-datetime", + "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": "string" - } - }, - "type": "object" - }, - "GoogleCloudNetworksecurityV1CertificateProvider": { - "description": "Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication.", - "id": "GoogleCloudNetworksecurityV1CertificateProvider", - "properties": { - "certificateProviderInstance": { - "$ref": "CertificateProviderInstance", - "description": "The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information." - }, - "grpcEndpoint": { - "$ref": "GoogleCloudNetworksecurityV1GrpcEndpoint", - "description": "gRPC specific configuration to access the gRPC server to obtain the cert and private key." - } - }, - "type": "object" - }, - "GoogleCloudNetworksecurityV1GrpcEndpoint": { - "description": "Specification of the GRPC Endpoint.", - "id": "GoogleCloudNetworksecurityV1GrpcEndpoint", - "properties": { - "targetUri": { - "description": "Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with \"unix:\".", - "type": "string" - } - }, - "type": "object" - }, - "GoogleIamV1AuditConfig": { - "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": "GoogleIamV1AuditConfig", - "properties": { - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.", - "items": { - "$ref": "GoogleIamV1AuditLogConfig" - }, - "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" - }, - "GoogleIamV1AuditLogConfig": { - "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": "GoogleIamV1AuditLogConfig", - "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" + "type": "boolean" }, - "logType": { - "description": "The log type that this config enables.", + "state": { + "description": "Output only. The current state of the endpoint group. See https://google.aip.dev/216.", "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" + "STATE_UNSPECIFIED", + "ACTIVE", + "CLOSED", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" ], "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" + "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. 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" }, - "GoogleIamV1Binding": { - "description": "Associates `members`, or principals, with a `role`.", - "id": "GoogleIamV1Binding", + "InterceptEndpointGroupAssociation": { + "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": { - "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)." + "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" }, - "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": { + "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" }, - "type": "array" + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", + "type": "object" }, - "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" - }, - "GoogleIamV1Policy": { - "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": "GoogleIamV1Policy", - "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", + "locations": { + "description": "Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group.", "items": { - "$ref": "GoogleIamV1AuditConfig" + "$ref": "InterceptLocation" }, + "readOnly": true, "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`.", + "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": "GoogleIamV1Binding" + "$ref": "InterceptEndpointGroupAssociationLocationDetails" }, + "readOnly": true, "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", + "name": { + "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" }, - "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" + "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. 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" }, - "GoogleIamV1SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "GoogleIamV1SetIamPolicyRequest", + "InterceptEndpointGroupAssociationDetails": { + "description": "The endpoint group's view of a connected association.", + "id": "InterceptEndpointGroupAssociationDetails", "properties": { - "policy": { - "$ref": "GoogleIamV1Policy", - "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." + "name": { + "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" }, - "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", + "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" + }, + "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" }, - "GoogleIamV1TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "GoogleIamV1TestIamPermissionsRequest", + "InterceptEndpointGroupAssociationLocationDetails": { + "description": "Contains details about the state of an association in a specific cloud location.", + "id": "InterceptEndpointGroupAssociationLocationDetails", "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" + "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": [ + "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" }, - "GoogleIamV1TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "GoogleIamV1TestIamPermissionsResponse", + "InterceptEndpointGroupConnectedDeploymentGroup": { + "description": "The endpoint group's view of a connected deployment group.", + "id": "InterceptEndpointGroupConnectedDeploymentGroup", "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "locations": { + "description": "Output only. The list of locations where the deployment group is present.", "items": { - "type": "string" + "$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" }, - "HttpHeaderMatch": { - "description": "Specification of HTTP header match attributes.", - "id": "HttpHeaderMatch", + "InterceptLocation": { + "description": "Details about intercept in a specific cloud location.", + "id": "InterceptLocation", "properties": { - "headerName": { - "description": "Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\".", + "location": { + "description": "Output only. The cloud location, e.g. \"us-central1-a\" or \"asia-south1\".", + "readOnly": true, "type": "string" }, - "regexMatch": { - "description": "Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier.", + "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" } }, @@ -5557,6 +6765,85 @@ }, "type": "object" }, + "ListInterceptDeploymentGroupsResponse": { + "description": "Response message for ListInterceptDeploymentGroups.", + "id": "ListInterceptDeploymentGroupsResponse", + "properties": { + "interceptDeploymentGroups": { + "description": "The deployment groups from the specified parent.", + "items": { + "$ref": "InterceptDeploymentGroup" + }, + "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" + }, + "ListInterceptDeploymentsResponse": { + "description": "Response message for ListInterceptDeployments.", + "id": "ListInterceptDeploymentsResponse", + "properties": { + "interceptDeployments": { + "description": "The deployments from the specified parent.", + "items": { + "$ref": "InterceptDeployment" + }, + "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" + }, + "ListInterceptEndpointGroupAssociationsResponse": { + "description": "Response message for ListInterceptEndpointGroupAssociations.", + "id": "ListInterceptEndpointGroupAssociationsResponse", + "properties": { + "interceptEndpointGroupAssociations": { + "description": "The associations from the specified parent.", + "items": { + "$ref": "InterceptEndpointGroupAssociation" + }, + "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" + }, + "ListInterceptEndpointGroupsResponse": { + "description": "Response message for ListInterceptEndpointGroups.", + "id": "ListInterceptEndpointGroupsResponse", + "properties": { + "interceptEndpointGroups": { + "description": "The endpoint groups from the specified parent.", + "items": { + "$ref": "InterceptEndpointGroup" + }, + "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" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 90d8e6a9b67..3e821b71750 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -1077,6 +1077,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -5064,7 +5070,7 @@ } } }, - "revision": "20250310", + "revision": "20250416", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5203,7 +5209,7 @@ ], "enumDescriptions": [ "Protocol not specified.", - "SMTP prtocol", + "SMTP protocol", "SMB protocol", "POP3 protocol", "IMAP protocol", diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 089e1ec2c19..03343b7cabb 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -743,6 +749,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}/endpointPolicies", @@ -1124,6 +1135,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}/grpcRoutes", @@ -1281,6 +1297,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}/httpRoutes", @@ -2434,6 +2455,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}/tcpRoutes", @@ -2591,6 +2617,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}/tlsRoutes", @@ -2939,7 +2970,7 @@ } } }, - "revision": "20250310", + "revision": "20250423", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3075,7 +3106,7 @@ ], "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 are sent as part of the same gRPC stream." + "The extension service uses ext_proc 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" } @@ -3307,7 +3338,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", "type": "object" }, "name": { @@ -3344,7 +3375,7 @@ "type": "array" }, "timeout": { - "description": "Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`1000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.", "format": "google-duration", "type": "string" } @@ -3820,7 +3851,7 @@ "id": "GrpcRouteStatefulSessionAffinityPolicy", "properties": { "cookieTtl": { - "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.", "format": "google-duration", "type": "string" } @@ -4365,7 +4396,7 @@ "id": "HttpRouteStatefulSessionAffinityPolicy", "properties": { "cookieTtl": { - "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.", "format": "google-duration", "type": "string" } @@ -4409,7 +4440,7 @@ "type": "array" }, "forwardingRules": { - "description": "Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LbRouteExtension` resource per forwarding rule.", + "description": "Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbRouteExtension` resource can be associated with a forwarding rule.", "items": { "type": "string" }, @@ -4441,7 +4472,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_route_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.", "type": "object" }, "name": { @@ -4479,7 +4510,7 @@ "type": "array" }, "forwardingRules": { - "description": "Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LBTrafficExtension` resource per forwarding rule.", + "description": "Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbTrafficExtension` resource can be associated with a forwarding rule.", "items": { "type": "string" }, @@ -4511,7 +4542,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.", "type": "object" }, "name": { @@ -4566,6 +4597,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" @@ -4634,6 +4672,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" @@ -4652,6 +4697,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" @@ -4856,6 +4908,13 @@ "$ref": "TcpRoute" }, "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" @@ -4874,6 +4933,13 @@ "$ref": "TlsRoute" }, "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" @@ -4886,6 +4952,13 @@ "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" + }, "wasmPluginVersions": { "description": "List of `WasmPluginVersion` resources.", "items": { @@ -4904,6 +4977,13 @@ "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" + }, "wasmPlugins": { "description": "List of `WasmPlugin` resources.", "items": { @@ -5195,7 +5275,7 @@ "type": "object" }, "ServiceBinding": { - "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.", + "description": "ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. This feature will be deprecated soon. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers. - Bind a Cloud Run service to be used in consumer Cloud Service Mesh or Application Load Balancers.", "id": "ServiceBinding", "properties": { "createTime": { @@ -5220,11 +5300,13 @@ "type": "string" }, "service": { - "description": "Optional. The full Service Directory Service name of the format `projects/*/locations/*/namespaces/*/services/*`. This field must be set.", + "deprecated": true, + "description": "Optional. The full Service Directory Service name of the format `projects/*/locations/*/namespaces/*/services/*`. This field is for Service Directory integration which will be deprecated soon.", "type": "string" }, "serviceId": { - "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.", + "deprecated": true, + "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. This field is for Service Directory integration which will be deprecated soon.", "readOnly": true, "type": "string" }, @@ -5611,7 +5693,7 @@ "type": "string" }, "weight": { - "description": "Optional. Specifies the proportion of requests forwareded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100.", + "description": "Optional. Specifies the proportion of requests forwarded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100.", "format": "int32", "type": "integer" } diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 906183477f9..a7ed95b1a7a 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -470,6 +476,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}/endpointPolicies", @@ -851,6 +862,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}/grpcRoutes", @@ -1008,6 +1024,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}/httpRoutes", @@ -1054,6 +1075,188 @@ } } }, + "lbEdgeExtensions": { + "methods": { + "create": { + "description": "Creates a new `LbEdgeExtension` resource in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions", + "httpMethod": "POST", + "id": "networkservices.projects.locations.lbEdgeExtensions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "lbEdgeExtensionId": { + "description": "Required. User-provided ID of the `LbEdgeExtension` resource to be created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the `LbEdgeExtension` resource. Must be in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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" + } + }, + "path": "v1beta1/{+parent}/lbEdgeExtensions", + "request": { + "$ref": "LbEdgeExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified `LbEdgeExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", + "httpMethod": "DELETE", + "id": "networkservices.projects.locations.lbEdgeExtensions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `LbEdgeExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specified `LbEdgeExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbEdgeExtensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the `LbEdgeExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "LbEdgeExtension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `LbEdgeExtension` resources in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbEdgeExtensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint about how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results that the server returns.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the `LbEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/lbEdgeExtensions", + "response": { + "$ref": "ListLbEdgeExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of the specified `LbEdgeExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.lbEdgeExtensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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" + }, + "updateMask": { + "description": "Optional. Used to specify the fields to be overwritten in the `LbEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "LbEdgeExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "lbRouteExtensions": { "methods": { "create": { @@ -2161,6 +2364,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}/tcpRoutes", @@ -2318,6 +2526,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}/tlsRoutes", @@ -2666,7 +2879,7 @@ } } }, - "revision": "20250310", + "revision": "20250410", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -2754,7 +2967,7 @@ ], "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 are sent as part of the same gRPC stream." + "The extension service uses ext_proc 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" } @@ -2878,6 +3091,10 @@ "description": "A single extension in the chain to execute for the matching request.", "id": "ExtensionChainExtension", "properties": { + "allowDynamicForwarding": { + "description": "Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error.", + "type": "boolean" + }, "authority": { "description": "Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.", "type": "string" @@ -2898,13 +3115,41 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", "type": "object" }, "name": { "description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", "type": "string" }, + "requestBodySendMode": { + "description": "Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.", + "enum": [ + "BODY_SEND_MODE_UNSPECIFIED", + "BODY_SEND_MODE_STREAMED", + "BODY_SEND_MODE_FULL_DUPLEX_STREAMED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Calls to the extension are executed in the streamed mode. Subsequent chunks will be sent only after the previous chunks have been processed. The content of the body chunks is sent one way to the extension. Extension may send modified chunks back. This is the default value if the processing mode is not specified.", + "Calls are executed in the full duplex mode. Subsequent chunks will be sent for processing without waiting for the response for the previous chunk or for the response for `REQUEST_HEADERS` event. Extension can freely modify or chunk the body contents. If the extension doesn't send the body contents back, the next extension in the chain or the upstream will receive an empty body." + ], + "type": "string" + }, + "responseBodySendMode": { + "description": "Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.", + "enum": [ + "BODY_SEND_MODE_UNSPECIFIED", + "BODY_SEND_MODE_STREAMED", + "BODY_SEND_MODE_FULL_DUPLEX_STREAMED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Calls to the extension are executed in the streamed mode. Subsequent chunks will be sent only after the previous chunks have been processed. The content of the body chunks is sent one way to the extension. Extension may send modified chunks back. This is the default value if the processing mode is not specified.", + "Calls are executed in the full duplex mode. Subsequent chunks will be sent for processing without waiting for the response for the previous chunk or for the response for `REQUEST_HEADERS` event. Extension can freely modify or chunk the body contents. If the extension doesn't send the body contents back, the next extension in the chain or the upstream will receive an empty body." + ], + "type": "string" + }, "service": { "description": "Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension` and the `LbRouteExtension` resources.", "type": "string" @@ -3411,7 +3656,7 @@ "id": "GrpcRouteStatefulSessionAffinityPolicy", "properties": { "cookieTtl": { - "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.", "format": "google-duration", "type": "string" } @@ -3956,7 +4201,7 @@ "id": "HttpRouteStatefulSessionAffinityPolicy", "properties": { "cookieTtl": { - "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.", "format": "google-duration", "type": "string" } @@ -3978,6 +4223,68 @@ }, "type": "object" }, + "LbEdgeExtension": { + "description": "`LbEdgeExtension` is a resource that lets the extension service influence the Backend Service selection or Cloud CDN cache keys by modifying the request headers.", + "id": "LbEdgeExtension", + "properties": { + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A human-readable description of the resource.", + "type": "string" + }, + "extensionChains": { + "description": "Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.", + "items": { + "$ref": "ExtensionChain" + }, + "type": "array" + }, + "forwardingRules": { + "description": "Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.", + "type": "object" + }, + "loadBalancingScheme": { + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `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", + "EXTERNAL_MANAGED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Signifies that this is used for Internal HTTP(S) Load Balancing.", + "Signifies that this is used for External Managed HTTP(S) Load Balancing." + ], + "type": "string" + }, + "name": { + "description": "Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "LbRouteExtension": { "description": "`LbRouteExtension` is a resource that lets you control where traffic is routed to for a given request.", "id": "LbRouteExtension", @@ -4000,7 +4307,7 @@ "type": "array" }, "forwardingRules": { - "description": "Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LbRouteExtension` resource per forwarding rule.", + "description": "Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbRouteExtension` resource can be associated with a forwarding rule.", "items": { "type": "string" }, @@ -4032,7 +4339,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_route_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.", "type": "object" }, "name": { @@ -4070,7 +4377,7 @@ "type": "array" }, "forwardingRules": { - "description": "Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LBTrafficExtension` resource per forwarding rule.", + "description": "Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbTrafficExtension` resource can be associated with a forwarding rule.", "items": { "type": "string" }, @@ -4102,7 +4409,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.", "type": "object" }, "name": { @@ -4157,6 +4464,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" @@ -4225,6 +4539,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" @@ -4243,6 +4564,38 @@ "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" + }, + "ListLbEdgeExtensionsResponse": { + "description": "Message for response to listing `LbEdgeExtension` resources.", + "id": "ListLbEdgeExtensionsResponse", + "properties": { + "lbEdgeExtensions": { + "description": "The list of `LbEdgeExtension` resources.", + "items": { + "$ref": "LbEdgeExtension" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results that the server returns.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4447,6 +4800,13 @@ "$ref": "TcpRoute" }, "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" @@ -4465,6 +4825,13 @@ "$ref": "TlsRoute" }, "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" @@ -4477,6 +4844,13 @@ "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" + }, "wasmPluginVersions": { "description": "List of `WasmPluginVersion` resources.", "items": { @@ -4495,6 +4869,13 @@ "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" + }, "wasmPlugins": { "description": "List of `WasmPlugin` resources.", "items": { @@ -4798,7 +5179,7 @@ "type": "object" }, "ServiceBinding": { - "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.", + "description": "ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. This feature will be deprecated soon. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers. - Bind a Cloud Run service to be used in consumer Cloud Service Mesh or Application Load Balancers.", "id": "ServiceBinding", "properties": { "createTime": { @@ -4823,11 +5204,13 @@ "type": "string" }, "service": { - "description": "Optional. The full Service Directory Service name of the format `projects/*/locations/*/namespaces/*/services/*`. This field must be set.", + "deprecated": true, + "description": "Optional. The full Service Directory Service name of the format `projects/*/locations/*/namespaces/*/services/*`. This field is for Service Directory integration which will be deprecated soon.", "type": "string" }, "serviceId": { - "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.", + "deprecated": true, + "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. This field is for Service Directory integration which will be deprecated soon.", "readOnly": true, "type": "string" }, @@ -5170,7 +5553,7 @@ "type": "string" }, "weight": { - "description": "Optional. Specifies the proportion of requests forwareded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100.", + "description": "Optional. Specifies the proportion of requests forwarded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100.", "format": "int32", "type": "integer" } diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index dde6ccfe7fd..4ac42a5a0ab 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -904,7 +904,7 @@ } } }, - "revision": "20250224", + "revision": "20250319", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1063,6 +1063,33 @@ }, "type": "object" }, + "ConfidentialInstanceConfig": { + "description": "A set of Confidential Instance options.", + "id": "ConfidentialInstanceConfig", + "properties": { + "confidentialInstanceType": { + "description": "Optional. 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" + }, + "enableConfidentialCompute": { + "description": "Optional. Defines whether the instance should have confidential compute enabled.", + "type": "boolean" + } + }, + "type": "object" + }, "Config": { "description": "Response for getting WbI configurations in a location", "id": "Config", @@ -1309,6 +1336,10 @@ "$ref": "BootDisk", "description": "Optional. The boot disk for the VM." }, + "confidentialInstanceConfig": { + "$ref": "ConfidentialInstanceConfig", + "description": "Optional. Confidential instance configuration." + }, "containerImage": { "$ref": "ContainerImage", "description": "Optional. Use a container image to start the notebook instance." diff --git a/discovery/observability-v1.json b/discovery/observability-v1.json new file mode 100644 index 00000000000..f30e38ef403 --- /dev/null +++ b/discovery/observability-v1.json @@ -0,0 +1,594 @@ +{ + "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://observability.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Observability", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/stackdriver/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": "observability:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://observability.mtls.googleapis.com/", + "name": "observability", + "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": "observability.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": "observability.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, + "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": { + "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": "observability.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": "observability.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": "observability.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": "observability.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" + ] + } + } + }, + "scopes": { + "methods": { + "get": { + "description": "Gets details of a single Scope.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}", + "httpMethod": "GET", + "id": "observability.projects.locations.scopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Scope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Scope.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}", + "httpMethod": "PATCH", + "id": "observability.projects.locations.scopes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Scope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten when it is in the mask. If the user does not provide a mask, then all fields present in the request are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Scope" + }, + "response": { + "$ref": "Scope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250417", + "rootUrl": "https://observability.googleapis.com/", + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, 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" + }, + "Scope": { + "description": "Message describing Scope object", + "id": "Scope", + "properties": { + "logScope": { + "description": "Required. The full resource name of the `LogScope`. For example: //logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Update timestamp. Note: The Update timestamp for the default scope is initially unset.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Observability API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index fd5c6994d88..0ed8e41e2d9 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20250217", + "revision": "20250321", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -532,7 +532,7 @@ "properties": { "binaryVersion": { "$ref": "PackageVersion", - "description": "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." + "description": "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." }, "sourceVersion": { "$ref": "PackageVersion", @@ -1637,7 +1637,7 @@ "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.", + "description": "Details about the layer a package was found in.", "id": "LayerDetails", "properties": { "baseImages": { @@ -2063,7 +2063,7 @@ "type": "string" }, "patchedCve": { - "description": "CVEs that this package is no longer vulnerable to go/drydock-dd-custom-binary-scanning", + "description": "CVEs that this package is no longer vulnerable to", "items": { "type": "string" }, diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index 5a590a13c6d..7ab008c1eb4 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20250217", + "revision": "20250321", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -527,7 +527,7 @@ "properties": { "binaryVersion": { "$ref": "PackageVersion", - "description": "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." + "description": "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." }, "sourceVersion": { "$ref": "PackageVersion", @@ -1632,7 +1632,7 @@ "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.", + "description": "Details about the layer a package was found in.", "id": "LayerDetails", "properties": { "baseImages": { @@ -2058,7 +2058,7 @@ "type": "string" }, "patchedCve": { - "description": "CVEs that this package is no longer vulnerable to go/drydock-dd-custom-binary-scanning", + "description": "CVEs that this package is no longer vulnerable to", "items": { "type": "string" }, diff --git a/discovery/oracledatabase-v1.json b/discovery/oracledatabase-v1.json index fb72bdb491e..ea8344cef68 100644 --- a/discovery/oracledatabase-v1.json +++ b/discovery/oracledatabase-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -547,6 +553,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "switchover": { + "description": "Initiates a switchover of specified autonomous deatabase to the associated peer database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:switchover", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.autonomousDatabases.switchover", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:switchover", + "request": { + "$ref": "SwitchoverAutonomousDatabaseRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1203,7 +1237,7 @@ } } }, - "revision": "20250312", + "revision": "20250416", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -1250,6 +1284,14 @@ "description": "Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.", "type": "string" }, + "disasterRecoverySupportedLocations": { + "description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "displayName": { "description": "Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.", "type": "string" @@ -1274,9 +1316,21 @@ "description": "Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", "type": "string" }, + "peerAutonomousDatabases": { + "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "properties": { "$ref": "AutonomousDatabaseProperties", "description": "Optional. The properties of the Autonomous Database." + }, + "sourceConfig": { + "$ref": "SourceConfig", + "description": "Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation." } }, "type": "object" @@ -1599,6 +1653,13 @@ "readOnly": true, "type": "number" }, + "allowlistedIps": { + "description": "Optional. The list of allowlisted IP addresses for the Autonomous Database.", + "items": { + "type": "string" + }, + "type": "array" + }, "apexDetails": { "$ref": "AutonomousDatabaseApex", "description": "Output only. The details for the Oracle APEX Application Development.", @@ -1658,6 +1719,12 @@ }, "type": "array" }, + "dataGuardRoleChangedTime": { + "description": "Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "dataSafeState": { "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", "enum": [ @@ -1748,6 +1815,12 @@ ], "type": "string" }, + "disasterRecoveryRoleChangedTime": { + "description": "Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "failedDataRecoveryDuration": { "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", "format": "google-duration", @@ -2320,6 +2393,21 @@ "format": "int32", "type": "integer" }, + "computeModel": { + "description": "Output only. The compute model of the Exadata Infrastructure.", + "enum": [ + "COMPUTE_MODEL_UNSPECIFIED", + "COMPUTE_MODEL_ECPU", + "COMPUTE_MODEL_OCPU" + ], + "enumDescriptions": [ + "Unspecified compute model.", + "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", + "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + ], + "readOnly": true, + "type": "string" + }, "cpuCount": { "description": "Output only. The number of enabled CPU cores.", "format": "int32", @@ -2339,6 +2427,11 @@ "readOnly": true, "type": "number" }, + "databaseServerType": { + "description": "Output only. The database server type of the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, "dbNodeStorageSizeGb": { "description": "Output only. The local node storage allocated in GBs.", "format": "int32", @@ -2455,6 +2548,11 @@ "format": "int32", "type": "integer" }, + "storageServerType": { + "description": "Output only. The storage server type of the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, "storageServerVersion": { "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.", "readOnly": true, @@ -2473,11 +2571,11 @@ "id": "CloudVmCluster", "properties": { "backupSubnetCidr": { - "description": "Required. CIDR range of the backup subnet.", + "description": "Optional. CIDR range of the backup subnet.", "type": "string" }, "cidr": { - "description": "Required. Network settings. CIDR to use for cluster IP allocation.", + "description": "Optional. Network settings. CIDR to use for cluster IP allocation.", "type": "string" }, "createTime": { @@ -2511,7 +2609,7 @@ "type": "string" }, "network": { - "description": "Required. The name of the VPC network. Format: projects/{project}/global/networks/{network}", + "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", "type": "string" }, "properties": { @@ -2534,6 +2632,21 @@ "readOnly": true, "type": "string" }, + "computeModel": { + "description": "Output only. The compute model of the VM Cluster.", + "enum": [ + "COMPUTE_MODEL_UNSPECIFIED", + "COMPUTE_MODEL_ECPU", + "COMPUTE_MODEL_OCPU" + ], + "enumDescriptions": [ + "Unspecified compute model.", + "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", + "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + ], + "readOnly": true, + "type": "string" + }, "cpuCoreCount": { "description": "Required. Number of enabled CPU cores.", "format": "int32", @@ -3783,6 +3896,21 @@ }, "type": "object" }, + "SourceConfig": { + "description": "The source configuration for the standby Autonomnous Database.", + "id": "SourceConfig", + "properties": { + "automaticBackupsReplicationEnabled": { + "description": "Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard.", + "type": "boolean" + }, + "autonomousDatabase": { + "description": "Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source.", + "type": "string" + } + }, + "type": "object" + }, "StartAutonomousDatabaseRequest": { "description": "The request for `AutonomousDatabase.Start`.", "id": "StartAutonomousDatabaseRequest", @@ -3822,6 +3950,17 @@ "properties": {}, "type": "object" }, + "SwitchoverAutonomousDatabaseRequest": { + "description": "The request for `AutonomousDatabase.Switchover`.", + "id": "SwitchoverAutonomousDatabaseRequest", + "properties": { + "peerAutonomousDatabase": { + "description": "Required. The peer database name to switch over to.", + "type": "string" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", diff --git a/discovery/orgpolicy-v2.json b/discovery/orgpolicy-v2.json index 090c0e1d868..004c1eb516c 100644 --- a/discovery/orgpolicy-v2.json +++ b/discovery/orgpolicy-v2.json @@ -930,7 +930,7 @@ } } }, - "revision": "20250117", + "revision": "20250418", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -978,6 +978,10 @@ "description": "The human readable name. Mutable.", "type": "string" }, + "equivalentConstraint": { + "description": "Managed constraint and canned constraint sometimes can have equivalents. This field is used to store the equivalent constraint name.", + "type": "string" + }, "listConstraint": { "$ref": "GoogleCloudOrgpolicyV2ConstraintListConstraint", "description": "Defines this constraint as being a list constraint." diff --git a/discovery/osconfig-v1.json b/discovery/osconfig-v1.json index bc59253af71..741a5ea8e65 100644 --- a/discovery/osconfig-v1.json +++ b/discovery/osconfig-v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20241201", + "revision": "20250323", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -1495,6 +1495,50 @@ }, "type": "object" }, + "GoogleCloudOsconfigV2__OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudOsconfigV2__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" + }, "GoogleCloudOsconfigV2beta__OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudOsconfigV2beta__OperationMetadata", diff --git a/discovery/osconfig-v1alpha.json b/discovery/osconfig-v1alpha.json index 8449d2dbbc5..d7451d5a528 100644 --- a/discovery/osconfig-v1alpha.json +++ b/discovery/osconfig-v1alpha.json @@ -707,7 +707,7 @@ } } }, - "revision": "20241117", + "revision": "20250323", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -962,6 +962,50 @@ }, "type": "object" }, + "GoogleCloudOsconfigV2__OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudOsconfigV2__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" + }, "GoogleCloudOsconfigV2beta__OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudOsconfigV2beta__OperationMetadata", diff --git a/discovery/osconfig-v1beta.json b/discovery/osconfig-v1beta.json index 2d2a6461b9b..7cad5c879ba 100644 --- a/discovery/osconfig-v1beta.json +++ b/discovery/osconfig-v1beta.json @@ -689,7 +689,7 @@ } } }, - "revision": "20241201", + "revision": "20250323", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -1130,6 +1130,50 @@ }, "type": "object" }, + "GoogleCloudOsconfigV2__OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudOsconfigV2__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" + }, "GoogleCloudOsconfigV2beta__OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudOsconfigV2beta__OperationMetadata", diff --git a/discovery/osconfig-v2.json b/discovery/osconfig-v2.json new file mode 100644 index 00000000000..c41e746db0b --- /dev/null +++ b/discovery/osconfig-v2.json @@ -0,0 +1,2318 @@ +{ + "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://osconfig.googleapis.com/", + "batchPath": "batch", + "canonicalName": "OS Config", + "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "osconfig:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://osconfig.mtls.googleapis.com/", + "name": "osconfig", + "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": { + "folders": { + "resources": { + "locations": { + "resources": { + "global": { + "resources": { + "policyOrchestrators": { + "methods": { + "create": { + "description": "Creates a new policy orchestrator under the given folder resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway).", + "flatPath": "v2/folders/{foldersId}/locations/global/policyOrchestrators", + "httpMethod": "POST", + "id": "osconfig.folders.locations.global.policyOrchestrators.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name in the form of: * `organizations/{organization_id}/locations/global` * `folders/{folder_id}/locations/global` * `projects/{project_id_or_number}/locations/global`", + "location": "path", + "pattern": "^folders/[^/]+/locations/global$", + "required": true, + "type": "string" + }, + "policyOrchestratorId": { + "description": "Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent.", + "location": "query", + "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": "v2/{+parent}/policyOrchestrators", + "request": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an existing policy orchestrator resource, parented by a folder.", + "flatPath": "v2/folders/{foldersId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "DELETE", + "id": "osconfig.folders.locations.global.policyOrchestrators.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource to be deleted.", + "location": "path", + "pattern": "^folders/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves an existing policy orchestrator, parented by a folder.", + "flatPath": "v2/folders/{foldersId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "GET", + "id": "osconfig.folders.locations.global.policyOrchestrators.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name.", + "location": "path", + "pattern": "^folders/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the policy orchestrators under the given parent folder resource.", + "flatPath": "v2/folders/{foldersId}/locations/global/policyOrchestrators", + "httpMethod": "GET", + "id": "osconfig.folders.locations.global.policyOrchestrators.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 parent resource name.", + "location": "path", + "pattern": "^folders/[^/]+/locations/global$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/policyOrchestrators", + "response": { + "$ref": "GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing policy orchestrator, parented by a folder.", + "flatPath": "v2/folders/{foldersId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "PATCH", + "id": "osconfig.folders.locations.global.policyOrchestrators.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. In form of * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`", + "location": "path", + "pattern": "^folders/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "osconfig.folders.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+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": "v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "osconfig.folders.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+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": "v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "osconfig.folders.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+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": "v2/folders/{foldersId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "osconfig.folders.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": "^folders/[^/]+/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": "v2/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "organizations": { + "resources": { + "locations": { + "resources": { + "global": { + "resources": { + "policyOrchestrators": { + "methods": { + "create": { + "description": "Creates a new policy orchestrator under the given organizations resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway).", + "flatPath": "v2/organizations/{organizationsId}/locations/global/policyOrchestrators", + "httpMethod": "POST", + "id": "osconfig.organizations.locations.global.policyOrchestrators.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name in the form of: * `organizations/{organization_id}/locations/global` * `folders/{folder_id}/locations/global` * `projects/{project_id_or_number}/locations/global`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global$", + "required": true, + "type": "string" + }, + "policyOrchestratorId": { + "description": "Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent.", + "location": "query", + "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": "v2/{+parent}/policyOrchestrators", + "request": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an existing policy orchestrator resource, parented by an organization.", + "flatPath": "v2/organizations/{organizationsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "DELETE", + "id": "osconfig.organizations.locations.global.policyOrchestrators.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource to be deleted.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves an existing policy orchestrator, parented by an organization.", + "flatPath": "v2/organizations/{organizationsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "GET", + "id": "osconfig.organizations.locations.global.policyOrchestrators.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the policy orchestrators under the given parent organization resource.", + "flatPath": "v2/organizations/{organizationsId}/locations/global/policyOrchestrators", + "httpMethod": "GET", + "id": "osconfig.organizations.locations.global.policyOrchestrators.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 parent resource name.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/policyOrchestrators", + "response": { + "$ref": "GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing policy orchestrator, parented by an organization.", + "flatPath": "v2/organizations/{organizationsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "PATCH", + "id": "osconfig.organizations.locations.global.policyOrchestrators.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. In form of * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "osconfig.organizations.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+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": "v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "osconfig.organizations.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+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": "v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "osconfig.organizations.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+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": "v2/organizations/{organizationsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "osconfig.organizations.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": "^organizations/[^/]+/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": "v2/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "projects": { + "resources": { + "locations": { + "resources": { + "global": { + "resources": { + "policyOrchestrators": { + "methods": { + "create": { + "description": "Creates a new policy orchestrator under the given project resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway).", + "flatPath": "v2/projects/{projectsId}/locations/global/policyOrchestrators", + "httpMethod": "POST", + "id": "osconfig.projects.locations.global.policyOrchestrators.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name in the form of: * `organizations/{organization_id}/locations/global` * `folders/{folder_id}/locations/global` * `projects/{project_id_or_number}/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global$", + "required": true, + "type": "string" + }, + "policyOrchestratorId": { + "description": "Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent.", + "location": "query", + "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": "v2/{+parent}/policyOrchestrators", + "request": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an existing policy orchestrator resource, parented by a project.", + "flatPath": "v2/projects/{projectsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "DELETE", + "id": "osconfig.projects.locations.global.policyOrchestrators.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves an existing policy orchestrator, parented by a project.", + "flatPath": "v2/projects/{projectsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "GET", + "id": "osconfig.projects.locations.global.policyOrchestrators.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the policy orchestrators under the given parent project resource.", + "flatPath": "v2/projects/{projectsId}/locations/global/policyOrchestrators", + "httpMethod": "GET", + "id": "osconfig.projects.locations.global.policyOrchestrators.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 parent resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/policyOrchestrators", + "response": { + "$ref": "GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing policy orchestrator, parented by a project.", + "flatPath": "v2/projects/{projectsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}", + "httpMethod": "PATCH", + "id": "osconfig.projects.locations.global.policyOrchestrators.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. In form of * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/policyOrchestrators/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "osconfig.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": "v2/{+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": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "osconfig.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": "v2/{+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": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "osconfig.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": "v2/{+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": "v2/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "osconfig.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": "v2/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250323", + "rootUrl": "https://osconfig.googleapis.com/", + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "FixedOrPercent": { + "description": "Message encapsulating a value that can be either absolute (\"fixed\") or relative (\"percent\") to a value.", + "id": "FixedOrPercent", + "properties": { + "fixed": { + "description": "Specifies a fixed value.", + "format": "int32", + "type": "integer" + }, + "percent": { + "description": "Specifies the relative value defined as a percentage, which will be multiplied by a reference value.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata": { + "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", + "id": "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata", + "properties": { + "apiMethod": { + "description": "The OS policy assignment API method.", + "enum": [ + "API_METHOD_UNSPECIFIED", + "CREATE", + "UPDATE", + "DELETE" + ], + "enumDescriptions": [ + "Invalid value", + "Create OS policy assignment API method", + "Update OS policy assignment API method", + "Delete OS policy assignment API method" + ], + "type": "string" + }, + "osPolicyAssignment": { + "description": "Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`", + "type": "string" + }, + "rolloutStartTime": { + "description": "Rollout start time", + "format": "google-datetime", + "type": "string" + }, + "rolloutState": { + "description": "State of the rollout", + "enum": [ + "ROLLOUT_STATE_UNSPECIFIED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Invalid value", + "The rollout is in progress.", + "The rollout is being cancelled.", + "The rollout is cancelled.", + "The rollout has completed successfully." + ], + "type": "string" + }, + "rolloutUpdateTime": { + "description": "Rollout update time", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector": { + "description": "Selector containing locations in scope.", + "id": "GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector", + "properties": { + "includedLocations": { + "description": "Optional. Names of the locations in scope. Format: `us-central1-a`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector": { + "description": "Selector containing Cloud Resource Manager resource hierarchy nodes.", + "id": "GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector", + "properties": { + "includedFolders": { + "description": "Optional. Names of the folders in scope. Format: `folders/{folder_id}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedProjects": { + "description": "Optional. Names of the projects in scope. Format: `projects/{project_number}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2_OrchestrationScope_Selector": { + "description": "Selector for the resources in scope of orchestration.", + "id": "GoogleCloudOsconfigV2_OrchestrationScope_Selector", + "properties": { + "locationSelector": { + "$ref": "GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector", + "description": "Selector for selecting locations." + }, + "resourceHierarchySelector": { + "$ref": "GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector", + "description": "Selector for selecting resource hierarchy." + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState": { + "description": "Describes the state of a single iteration of the orchestrator.", + "id": "GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState", + "properties": { + "error": { + "$ref": "Status", + "description": "Output only. Error thrown in the wave iteration.", + "readOnly": true + }, + "failedActions": { + "description": "Output only. Number of orchestration actions which failed so far. For more details, query the Cloud Logs.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "finishTime": { + "description": "Output only. Finish time of the wave iteration.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "iterationId": { + "description": "Output only. Unique identifier of the iteration.", + "readOnly": true, + "type": "string" + }, + "performedActions": { + "description": "Output only. Overall number of actions done by the orchestrator so far.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "progress": { + "description": "Output only. An estimated percentage of the progress. Number between 0 and 100.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "startTime": { + "description": "Output only. Start time of the wave iteration.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the iteration.", + "enum": [ + "STATE_UNSPECIFIED", + "PROCESSING", + "COMPLETED", + "FAILED", + "CANCELLED", + "UNKNOWN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Iteration is in progress.", + "Iteration completed, with all actions being successful.", + "Iteration completed, with failures.", + "Iteration was explicitly cancelled.", + "Impossible to determine current state of the iteration." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState": { + "description": "Describes the state of the orchestration process.", + "id": "GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState", + "properties": { + "currentIterationState": { + "$ref": "GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState", + "description": "Output only. Current Wave iteration state.", + "readOnly": true + }, + "previousIterationState": { + "$ref": "GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState", + "description": "Output only. Previous Wave iteration state.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse": { + "description": "Response for the list policy orchestrator resources.", + "id": "GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse", + "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" + }, + "policyOrchestrators": { + "description": "The policy orchestrators for the specified parent resource.", + "items": { + "$ref": "GoogleCloudOsconfigV2__PolicyOrchestrator" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2__OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudOsconfigV2__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" + }, + "GoogleCloudOsconfigV2__OrchestratedResource": { + "description": "Represents a resource that is being orchestrated by the policy orchestrator.", + "id": "GoogleCloudOsconfigV2__OrchestratedResource", + "properties": { + "id": { + "description": "Optional. ID of the resource to be used while generating set of affected resources. For UPSERT action the value is auto-generated during PolicyOrchestrator creation when not set. When the value is set it should following next restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. For DELETE action, ID must be specified explicitly during PolicyOrchestrator creation.", + "type": "string" + }, + "osPolicyAssignmentV1Payload": { + "$ref": "OSPolicyAssignment", + "description": "Optional. OSPolicyAssignment resource to be created, updated or deleted. Name field is ignored and replace with a generated value. With this field set, orchestrator will perform actions on `project/{project}/locations/{zone}/osPolicyAssignments/{resource_id}` resources, where `project` and `zone` pairs come from the expanded scope, and `resource_id` comes from the `resource_id` field of orchestrator resource." + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2__OrchestrationScope": { + "description": "Defines a set of selectors which drive which resources are in scope of policy orchestration.", + "id": "GoogleCloudOsconfigV2__OrchestrationScope", + "properties": { + "selectors": { + "description": "Optional. Selectors of the orchestration scope. There is a logical AND between each selector defined. When there is no explicit `ResourceHierarchySelector` selector specified, the scope is by default bounded to the parent of the policy orchestrator resource.", + "items": { + "$ref": "GoogleCloudOsconfigV2_OrchestrationScope_Selector" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2__PolicyOrchestrator": { + "description": "PolicyOrchestrator helps managing project+zone level policy resources (e.g. OS Policy Assignments), by providing tools to create, update and delete them across projects and locations, at scale. Policy orchestrator functions as an endless loop. Each iteration orchestrator computes a set of resources that should be affected, then progressively applies changes to them. If for some reason this set of resources changes over time (e.g. new projects are added), the future loop iterations will address that. Orchestrator can either upsert or delete policy resources. For more details, see the description of the `action`, and `orchestrated_resource` fields. Note that policy orchestrator do not \"manage\" the resources it creates. Every iteration is independent and only minimal history of past actions is retained (apart from Cloud Logging). If orchestrator gets deleted, it does not affect the resources it created in the past. Those will remain where they were. Same applies if projects are removed from the orchestrator's scope.", + "id": "GoogleCloudOsconfigV2__PolicyOrchestrator", + "properties": { + "action": { + "description": "Required. Action to be done by the orchestrator in `projects/{project_id}/zones/{zone_id}` locations defined by the `orchestration_scope`. Allowed values: - `UPSERT` - Orchestrator will create or update target resources. - `DELETE` - Orchestrator will delete target resources, if they exist", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when the policy orchestrator resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Freeform text describing the purpose of the resource.", + "type": "string" + }, + "etag": { + "description": "Output only. 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.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. In form of * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`", + "type": "string" + }, + "orchestratedResource": { + "$ref": "GoogleCloudOsconfigV2__OrchestratedResource", + "description": "Required. Resource to be orchestrated by the policy orchestrator." + }, + "orchestrationScope": { + "$ref": "GoogleCloudOsconfigV2__OrchestrationScope", + "description": "Optional. Defines scope for the orchestration, in context of the enclosing PolicyOrchestrator resource. Scope is expanded into a list of pairs, in which the rollout action will take place. Expansion starts with a Folder resource parenting the PolicyOrchestrator resource: - All the descendant projects are listed. - List of project is cross joined with a list of all available zones. - Resulting list of pairs is filtered according to the selectors." + }, + "orchestrationState": { + "$ref": "GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState", + "description": "Output only. State of the orchestration.", + "readOnly": true + }, + "reconciling": { + "description": "Output only. Set to true, if the there are ongoing changes being applied by the orchestrator.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Optional. State of the orchestrator. Can be updated to change orchestrator behaviour. Allowed values: - `ACTIVE` - orchestrator is actively looking for actions to be taken. - `STOPPED` - orchestrator won't make any changes. Note: There might be more states added in the future. We use string here instead of an enum, to avoid the need of propagating new states to all the client code.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the policy orchestrator resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudOsconfigV2beta__OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudOsconfigV2beta__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" + }, + "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" + }, + "OSPolicy": { + "description": "An OS policy defines the desired state configuration for a VM.", + "id": "OSPolicy", + "properties": { + "allowNoResourceGroupMatch": { + "description": "This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce.", + "type": "boolean" + }, + "description": { + "description": "Policy description. Length of the description is limited to 1024 characters.", + "type": "string" + }, + "id": { + "description": "Required. The id of the OS policy with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the assignment.", + "type": "string" + }, + "mode": { + "description": "Required. Policy mode", + "enum": [ + "MODE_UNSPECIFIED", + "VALIDATION", + "ENFORCEMENT" + ], + "enumDescriptions": [ + "Invalid mode", + "This mode checks if the configuration resources in the policy are in their desired state. No actions are performed if they are not in the desired state. This mode is used for reporting purposes.", + "This mode checks if the configuration resources in the policy are in their desired state, and if not, enforces the desired state." + ], + "type": "string" + }, + "resourceGroups": { + "description": "Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`", + "items": { + "$ref": "OSPolicyResourceGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "OSPolicyAssignment": { + "description": "OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information about the OS policy resource definitions and examples, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).", + "id": "OSPolicyAssignment", + "properties": { + "baseline": { + "description": "Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.", + "readOnly": true, + "type": "boolean" + }, + "deleted": { + "description": "Output only. Indicates that this revision deletes the OS policy assignment.", + "readOnly": true, + "type": "boolean" + }, + "description": { + "description": "OS policy assignment description. Length of the description is limited to 1024 characters.", + "type": "string" + }, + "etag": { + "description": "The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.", + "type": "string" + }, + "instanceFilter": { + "$ref": "OSPolicyAssignmentInstanceFilter", + "description": "Required. Filter to select VMs." + }, + "name": { + "description": "Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment.", + "type": "string" + }, + "osPolicies": { + "description": "Required. List of OS policies to be applied to the VMs.", + "items": { + "$ref": "OSPolicy" + }, + "type": "array" + }, + "reconciling": { + "description": "Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING", + "readOnly": true, + "type": "boolean" + }, + "revisionCreateTime": { + "description": "Output only. The timestamp that the revision was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "revisionId": { + "description": "Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment", + "readOnly": true, + "type": "string" + }, + "rollout": { + "$ref": "OSPolicyAssignmentRollout", + "description": "Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted." + }, + "rolloutState": { + "description": "Output only. OS policy assignment rollout state", + "enum": [ + "ROLLOUT_STATE_UNSPECIFIED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Invalid value", + "The rollout is in progress.", + "The rollout is being cancelled.", + "The rollout is cancelled.", + "The rollout has completed successfully." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. Server generated unique id for the OS policy assignment resource.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyAssignmentInstanceFilter": { + "description": "Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.", + "id": "OSPolicyAssignmentInstanceFilter", + "properties": { + "all": { + "description": "Target all VMs in the project. If true, no other criteria is permitted.", + "type": "boolean" + }, + "exclusionLabels": { + "description": "List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM.", + "items": { + "$ref": "OSPolicyAssignmentLabelSet" + }, + "type": "array" + }, + "inclusionLabels": { + "description": "List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM.", + "items": { + "$ref": "OSPolicyAssignmentLabelSet" + }, + "type": "array" + }, + "inventories": { + "description": "List of inventories to select VMs. A VM is selected if its inventory data matches at least one of the following inventories.", + "items": { + "$ref": "OSPolicyAssignmentInstanceFilterInventory" + }, + "type": "array" + } + }, + "type": "object" + }, + "OSPolicyAssignmentInstanceFilterInventory": { + "description": "VM inventory details.", + "id": "OSPolicyAssignmentInstanceFilterInventory", + "properties": { + "osShortName": { + "description": "Required. The OS short name", + "type": "string" + }, + "osVersion": { + "description": "The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` An empty string matches all OS versions.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyAssignmentLabelSet": { + "description": "Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present.", + "id": "OSPolicyAssignmentLabelSet", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected.", + "type": "object" + } + }, + "type": "object" + }, + "OSPolicyAssignmentOperationMetadata": { + "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", + "id": "OSPolicyAssignmentOperationMetadata", + "properties": { + "apiMethod": { + "description": "The OS policy assignment API method.", + "enum": [ + "API_METHOD_UNSPECIFIED", + "CREATE", + "UPDATE", + "DELETE" + ], + "enumDescriptions": [ + "Invalid value", + "Create OS policy assignment API method", + "Update OS policy assignment API method", + "Delete OS policy assignment API method" + ], + "type": "string" + }, + "osPolicyAssignment": { + "description": "Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`", + "type": "string" + }, + "rolloutStartTime": { + "description": "Rollout start time", + "format": "google-datetime", + "type": "string" + }, + "rolloutState": { + "description": "State of the rollout", + "enum": [ + "ROLLOUT_STATE_UNSPECIFIED", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Invalid value", + "The rollout is in progress.", + "The rollout is being cancelled.", + "The rollout is cancelled.", + "The rollout has completed successfully." + ], + "type": "string" + }, + "rolloutUpdateTime": { + "description": "Rollout update time", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyAssignmentRollout": { + "description": "Message to configure the rollout at the zonal level for the OS policy assignment.", + "id": "OSPolicyAssignmentRollout", + "properties": { + "disruptionBudget": { + "$ref": "FixedOrPercent", + "description": "Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment." + }, + "minWaitDuration": { + "description": "Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyInventoryFilter": { + "description": "Filtering criteria to select VMs based on inventory details.", + "id": "OSPolicyInventoryFilter", + "properties": { + "osShortName": { + "description": "Required. The OS short name", + "type": "string" + }, + "osVersion": { + "description": "The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` An empty string matches all OS versions.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResource": { + "description": "An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.", + "id": "OSPolicyResource", + "properties": { + "exec": { + "$ref": "OSPolicyResourceExecResource", + "description": "Exec resource" + }, + "file": { + "$ref": "OSPolicyResourceFileResource", + "description": "File resource" + }, + "id": { + "description": "Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the OS policy.", + "type": "string" + }, + "pkg": { + "$ref": "OSPolicyResourcePackageResource", + "description": "Package resource" + }, + "repository": { + "$ref": "OSPolicyResourceRepositoryResource", + "description": "Package repository resource" + } + }, + "type": "object" + }, + "OSPolicyResourceExecResource": { + "description": "A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen.", + "id": "OSPolicyResourceExecResource", + "properties": { + "enforce": { + "$ref": "OSPolicyResourceExecResourceExec", + "description": "What to run to bring this resource into the desired state. An exit code of 100 indicates \"success\", any other exit code indicates a failure running enforce." + }, + "validate": { + "$ref": "OSPolicyResourceExecResourceExec", + "description": "Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates \"in desired state\", and exit code of 101 indicates \"not in desired state\". Any other exit code indicates a failure running validate." + } + }, + "type": "object" + }, + "OSPolicyResourceExecResourceExec": { + "description": "A file or script to execute.", + "id": "OSPolicyResourceExecResourceExec", + "properties": { + "args": { + "description": "Optional arguments to pass to the source during execution.", + "items": { + "type": "string" + }, + "type": "array" + }, + "file": { + "$ref": "OSPolicyResourceFile", + "description": "A remote or local file." + }, + "interpreter": { + "description": "Required. The script interpreter to use.", + "enum": [ + "INTERPRETER_UNSPECIFIED", + "NONE", + "SHELL", + "POWERSHELL" + ], + "enumDescriptions": [ + "Invalid value, the request will return validation error.", + "If an interpreter is not specified, the source is executed directly. This execution, without an interpreter, only succeeds for executables and scripts that have shebang lines.", + "Indicates that the script runs with `/bin/sh` on Linux and `cmd.exe` on Windows.", + "Indicates that the script runs with PowerShell." + ], + "type": "string" + }, + "outputFilePath": { + "description": "Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes.", + "type": "string" + }, + "script": { + "description": "An inline script. The size of the script is limited to 32KiB.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceFile": { + "description": "A remote or local file.", + "id": "OSPolicyResourceFile", + "properties": { + "allowInsecure": { + "description": "Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.", + "type": "boolean" + }, + "gcs": { + "$ref": "OSPolicyResourceFileGcs", + "description": "A Cloud Storage object." + }, + "localPath": { + "description": "A local path within the VM to use.", + "type": "string" + }, + "remote": { + "$ref": "OSPolicyResourceFileRemote", + "description": "A generic remote file." + } + }, + "type": "object" + }, + "OSPolicyResourceFileGcs": { + "description": "Specifies a file available as a Cloud Storage Object.", + "id": "OSPolicyResourceFileGcs", + "properties": { + "bucket": { + "description": "Required. Bucket of the Cloud Storage object.", + "type": "string" + }, + "generation": { + "description": "Generation number of the Cloud Storage object.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Required. Name of the Cloud Storage object.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceFileRemote": { + "description": "Specifies a file available via some URI.", + "id": "OSPolicyResourceFileRemote", + "properties": { + "sha256Checksum": { + "description": "SHA256 checksum of the remote file.", + "type": "string" + }, + "uri": { + "description": "Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceFileResource": { + "description": "A resource that manages the state of a file.", + "id": "OSPolicyResourceFileResource", + "properties": { + "content": { + "description": "A a file with this content. The size of the content is limited to 32KiB.", + "type": "string" + }, + "file": { + "$ref": "OSPolicyResourceFile", + "description": "A remote or local source." + }, + "path": { + "description": "Required. The absolute path of the file within the VM.", + "type": "string" + }, + "permissions": { + "description": "Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4", + "type": "string" + }, + "state": { + "description": "Required. Desired state of the file.", + "enum": [ + "DESIRED_STATE_UNSPECIFIED", + "PRESENT", + "ABSENT", + "CONTENTS_MATCH" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Ensure file at path is present.", + "Ensure file at path is absent.", + "Ensure the contents of the file at path matches. If the file does not exist it will be created." + ], + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceGroup": { + "description": "Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group.", + "id": "OSPolicyResourceGroup", + "properties": { + "inventoryFilters": { + "description": "List of inventory filters for the resource group. The resources in this resource group are applied to the target VM if it satisfies at least one of the following inventory filters. For example, to apply this resource group to VMs running either `RHEL` or `CentOS` operating systems, specify 2 items for the list with following values: inventory_filters[0].os_short_name='rhel' and inventory_filters[1].os_short_name='centos' If the list is empty, this resource group will be applied to the target VM unconditionally.", + "items": { + "$ref": "OSPolicyInventoryFilter" + }, + "type": "array" + }, + "resources": { + "description": "Required. List of resources configured for this resource group. The resources are executed in the exact order specified here.", + "items": { + "$ref": "OSPolicyResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResource": { + "description": "A resource that manages a system package.", + "id": "OSPolicyResourcePackageResource", + "properties": { + "apt": { + "$ref": "OSPolicyResourcePackageResourceAPT", + "description": "A package managed by Apt." + }, + "deb": { + "$ref": "OSPolicyResourcePackageResourceDeb", + "description": "A deb package file." + }, + "desiredState": { + "description": "Required. The desired state the agent should maintain for this package.", + "enum": [ + "DESIRED_STATE_UNSPECIFIED", + "INSTALLED", + "REMOVED" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Ensure that the package is installed.", + "The agent ensures that the package is not installed and uninstalls it if detected." + ], + "type": "string" + }, + "googet": { + "$ref": "OSPolicyResourcePackageResourceGooGet", + "description": "A package managed by GooGet." + }, + "msi": { + "$ref": "OSPolicyResourcePackageResourceMSI", + "description": "An MSI package." + }, + "rpm": { + "$ref": "OSPolicyResourcePackageResourceRPM", + "description": "An rpm package file." + }, + "yum": { + "$ref": "OSPolicyResourcePackageResourceYUM", + "description": "A package managed by YUM." + }, + "zypper": { + "$ref": "OSPolicyResourcePackageResourceZypper", + "description": "A package managed by Zypper." + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResourceAPT": { + "description": "A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]`", + "id": "OSPolicyResourcePackageResourceAPT", + "properties": { + "name": { + "description": "Required. Package name.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResourceDeb": { + "description": "A deb package file. dpkg packages only support INSTALLED state.", + "id": "OSPolicyResourcePackageResourceDeb", + "properties": { + "pullDeps": { + "description": "Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`", + "type": "boolean" + }, + "source": { + "$ref": "OSPolicyResourceFile", + "description": "Required. A deb package." + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResourceGooGet": { + "description": "A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package`", + "id": "OSPolicyResourcePackageResourceGooGet", + "properties": { + "name": { + "description": "Required. Package name.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResourceMSI": { + "description": "An MSI package. MSI packages only support INSTALLED state.", + "id": "OSPolicyResourcePackageResourceMSI", + "properties": { + "properties": { + "description": "Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "source": { + "$ref": "OSPolicyResourceFile", + "description": "Required. The MSI package." + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResourceRPM": { + "description": "An RPM package file. RPM packages only support INSTALLED state.", + "id": "OSPolicyResourcePackageResourceRPM", + "properties": { + "pullDeps": { + "description": "Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`", + "type": "boolean" + }, + "source": { + "$ref": "OSPolicyResourceFile", + "description": "Required. An rpm package." + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResourceYUM": { + "description": "A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package`", + "id": "OSPolicyResourcePackageResourceYUM", + "properties": { + "name": { + "description": "Required. Package name.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourcePackageResourceZypper": { + "description": "A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package`", + "id": "OSPolicyResourcePackageResourceZypper", + "properties": { + "name": { + "description": "Required. Package name.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceRepositoryResource": { + "description": "A resource that manages a package repository.", + "id": "OSPolicyResourceRepositoryResource", + "properties": { + "apt": { + "$ref": "OSPolicyResourceRepositoryResourceAptRepository", + "description": "An Apt Repository." + }, + "goo": { + "$ref": "OSPolicyResourceRepositoryResourceGooRepository", + "description": "A Goo Repository." + }, + "yum": { + "$ref": "OSPolicyResourceRepositoryResourceYumRepository", + "description": "A Yum Repository." + }, + "zypper": { + "$ref": "OSPolicyResourceRepositoryResourceZypperRepository", + "description": "A Zypper Repository." + } + }, + "type": "object" + }, + "OSPolicyResourceRepositoryResourceAptRepository": { + "description": "Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`.", + "id": "OSPolicyResourceRepositoryResourceAptRepository", + "properties": { + "archiveType": { + "description": "Required. Type of archive files in this repository.", + "enum": [ + "ARCHIVE_TYPE_UNSPECIFIED", + "DEB", + "DEB_SRC" + ], + "enumDescriptions": [ + "Unspecified is invalid.", + "Deb indicates that the archive contains binary files.", + "Deb-src indicates that the archive contains source files." + ], + "type": "string" + }, + "components": { + "description": "Required. List of components for this repository. Must contain at least one item.", + "items": { + "type": "string" + }, + "type": "array" + }, + "distribution": { + "description": "Required. Distribution of this repository.", + "type": "string" + }, + "gpgKey": { + "description": "URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.", + "type": "string" + }, + "uri": { + "description": "Required. URI for this repository.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceRepositoryResourceGooRepository": { + "description": "Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`.", + "id": "OSPolicyResourceRepositoryResourceGooRepository", + "properties": { + "name": { + "description": "Required. The name of the repository.", + "type": "string" + }, + "url": { + "description": "Required. The url of the repository.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceRepositoryResourceYumRepository": { + "description": "Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`.", + "id": "OSPolicyResourceRepositoryResourceYumRepository", + "properties": { + "baseUrl": { + "description": "Required. The location of the repository directory.", + "type": "string" + }, + "displayName": { + "description": "The display name of the repository.", + "type": "string" + }, + "gpgKeys": { + "description": "URIs of GPG keys.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Required. A one word, unique name for this repository. This is the `repo id` in the yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for resource conflicts.", + "type": "string" + } + }, + "type": "object" + }, + "OSPolicyResourceRepositoryResourceZypperRepository": { + "description": "Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`.", + "id": "OSPolicyResourceRepositoryResourceZypperRepository", + "properties": { + "baseUrl": { + "description": "Required. The location of the repository directory.", + "type": "string" + }, + "displayName": { + "description": "The display name of the repository.", + "type": "string" + }, + "gpgKeys": { + "description": "URIs of GPG keys.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for GuestPolicy conflicts.", + "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" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "OS Config API", + "version": "v2", + "version_module": true +} \ No newline at end of file diff --git a/discovery/osconfig-v2beta.json b/discovery/osconfig-v2beta.json index 16532894730..a2a8bce880b 100644 --- a/discovery/osconfig-v2beta.json +++ b/discovery/osconfig-v2beta.json @@ -274,7 +274,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to update.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -591,7 +591,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to update.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -908,7 +908,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to update.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1057,7 +1057,7 @@ } } }, - "revision": "20241117", + "revision": "20250323", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1144,6 +1144,50 @@ }, "type": "object" }, + "GoogleCloudOsconfigV2__OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudOsconfigV2__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" + }, "GoogleCloudOsconfigV2beta_OrchestrationScope_LocationSelector": { "description": "Selector containing locations in scope.", "id": "GoogleCloudOsconfigV2beta_OrchestrationScope_LocationSelector", @@ -1215,6 +1259,11 @@ "readOnly": true, "type": "string" }, + "iterationId": { + "description": "Output only. Unique identifier of the iteration.", + "readOnly": true, + "type": "string" + }, "performedActions": { "description": "Output only. Overall number of actions done by the orchestrator so far.", "format": "int64", @@ -1227,11 +1276,6 @@ "readOnly": true, "type": "number" }, - "rolloutResource": { - "description": "Output only. Handle to the Progressive Rollouts API rollout resource, which contains detailed information about a particular orchestration iteration.", - "readOnly": true, - "type": "string" - }, "startTime": { "description": "Output only. Start time of the wave iteration.", "format": "google-datetime", diff --git a/discovery/oslogin-v1alpha.json b/discovery/oslogin-v1alpha.json index 0c0aa35fbd6..e427be64757 100644 --- a/discovery/oslogin-v1alpha.json +++ b/discovery/oslogin-v1alpha.json @@ -542,7 +542,7 @@ } } }, - "revision": "20250317", + "revision": "20250406", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -560,11 +560,11 @@ "type": "string" }, "computeInstance": { - "description": "The compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}", + "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", + "description": "Optional. The service account for the 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.", "type": "string" }, "sshPublicKey": { diff --git a/discovery/oslogin-v1beta.json b/discovery/oslogin-v1beta.json index 59d37284db0..6a9d33f1994 100644 --- a/discovery/oslogin-v1beta.json +++ b/discovery/oslogin-v1beta.json @@ -512,7 +512,7 @@ } } }, - "revision": "20250317", + "revision": "20250406", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -530,11 +530,11 @@ "type": "string" }, "computeInstance": { - "description": "The compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}", + "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", + "description": "Optional. The service account for the 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.", "type": "string" }, "sshPublicKey": { diff --git a/discovery/parallelstore-v1.json b/discovery/parallelstore-v1.json index 093eeb53246..ab947cce4c9 100644 --- a/discovery/parallelstore-v1.json +++ b/discovery/parallelstore-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -201,7 +207,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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).", + "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" } @@ -234,7 +240,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 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).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -391,7 +397,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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).", + "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" }, @@ -543,7 +549,7 @@ } } }, - "revision": "20250303", + "revision": "20250416", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -587,7 +593,7 @@ "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).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "serviceAccount": { @@ -620,7 +626,7 @@ "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).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "serviceAccount": { @@ -659,7 +665,7 @@ }, "daosVersion": { "deprecated": true, - "description": "Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance.", + "description": "Output only. Deprecated: The version of DAOS software running in the instance.", "readOnly": true, "type": "string" }, @@ -753,7 +759,7 @@ "The instance is being created.", "The instance is available for use.", "The instance is being deleted.", - "The instance is not usable.", + "LINT.IfChange The instance is not usable. LINT.ThenChange(//depot/google3/configs/monitoring/boq/daos_clh/cloud_precomputes_lib.py)", "The instance is being upgraded.", "The instance is being repaired. This should only be used by instances using the `PERSISTENT` deployment type." ], diff --git a/discovery/parallelstore-v1beta.json b/discovery/parallelstore-v1beta.json index 05254867c9b..a610cf2672b 100644 --- a/discovery/parallelstore-v1beta.json +++ b/discovery/parallelstore-v1beta.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -201,7 +207,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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).", + "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" } @@ -234,7 +240,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 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).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -391,7 +397,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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).", + "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" }, @@ -540,7 +546,7 @@ } } }, - "revision": "20250303", + "revision": "20250416", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "DestinationGcsBucket": { @@ -578,7 +584,7 @@ "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).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "serviceAccount": { @@ -611,7 +617,7 @@ "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).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "serviceAccount": { @@ -650,7 +656,7 @@ }, "daosVersion": { "deprecated": true, - "description": "Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance.", + "description": "Output only. Deprecated: The version of DAOS software running in the instance.", "readOnly": true, "type": "string" }, @@ -744,7 +750,7 @@ "The instance is being created.", "The instance is available for use.", "The instance is being deleted.", - "The instance is not usable.", + "LINT.IfChange The instance is not usable. LINT.ThenChange(//depot/google3/configs/monitoring/boq/daos_clh/cloud_precomputes_lib.py)", "The instance is being upgraded.", "The instance is being repaired. This should only be used by instances using the `PERSISTENT` deployment type." ], diff --git a/discovery/paymentsresellersubscription-v1.json b/discovery/paymentsresellersubscription-v1.json index 76ae39181d9..2d85b46c28c 100644 --- a/discovery/paymentsresellersubscription-v1.json +++ b/discovery/paymentsresellersubscription-v1.json @@ -2,8 +2,8 @@ "auth": { "oauth2": { "scopes": { - "openid": { - "description": "Associate you with your personal info on Google" + "https://www.googleapis.com/auth/sdm.service": { + "description": "See and/or control the devices that you selected" } } } @@ -147,7 +147,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] } } @@ -179,7 +179,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] }, "list": { @@ -220,7 +220,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] } } @@ -252,7 +252,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] }, "create": { @@ -285,7 +285,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1Subscription" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] }, "entitle": { @@ -313,7 +313,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] }, "extend": { @@ -341,7 +341,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] }, "get": { @@ -366,7 +366,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1Subscription" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] }, "provision": { @@ -399,7 +399,63 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1Subscription" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" + ] + }, + "resume": { + "description": "Resumes a suspended subscription. The new billing cycle will start at the time of the request. It should be called directly by the partner using service accounts.", + "flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:resume", + "httpMethod": "POST", + "id": "paymentsresellersubscription.partners.subscriptions.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subscription resource to be resumed. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"", + "location": "path", + "pattern": "^partners/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", + "request": { + "$ref": "GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest" + }, + "response": { + "$ref": "GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + }, + "suspend": { + "description": "Suspends a subscription. Contract terms may dictate if a prorated refund will be issued upon suspension. It should be called directly by the partner using service accounts.", + "flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:suspend", + "httpMethod": "POST", + "id": "paymentsresellersubscription.partners.subscriptions.suspend", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subscription resource to be suspended. It will have the format of \"partners/{partner_id}/subscriptions/{subscription_id}\"", + "location": "path", + "pattern": "^partners/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:suspend", + "request": { + "$ref": "GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest" + }, + "response": { + "$ref": "GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" ] }, "undoCancel": { @@ -427,7 +483,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] } } @@ -459,7 +515,7 @@ "$ref": "GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse" }, "scopes": [ - "openid" + "https://www.googleapis.com/auth/sdm.service" ] } } @@ -467,7 +523,7 @@ } } }, - "revision": "20250312", + "revision": "20250415", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -1125,6 +1181,23 @@ }, "type": "object" }, + "GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest": { + "description": "Request to resume a suspended subscription.", + "id": "GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse": { + "description": "Response that contains the resumed subscription.", + "id": "GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse", + "properties": { + "subscription": { + "$ref": "GoogleCloudPaymentsResellerSubscriptionV1Subscription", + "description": "The resumed subscription resource." + } + }, + "type": "object" + }, "GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod": { "description": "A description of what time period or moment in time the product or service is being delivered over.", "id": "GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod", @@ -1525,6 +1598,23 @@ }, "type": "object" }, + "GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest": { + "description": "Request to suspend a subscription.", + "id": "GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse": { + "description": "Response that contains the suspended subscription.", + "id": "GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse", + "properties": { + "subscription": { + "$ref": "GoogleCloudPaymentsResellerSubscriptionV1Subscription", + "description": "The suspended subscription resource." + } + }, + "type": "object" + }, "GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest": { "description": "Request to revoke a cancellation request.", "id": "GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest", diff --git a/discovery/places-v1.json b/discovery/places-v1.json index b4d82d74618..8fd29b9ef6a 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20250312", + "revision": "20250429", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -676,13 +676,12 @@ "$ref": "GoogleTypeLocalizedText", "description": "Content related to the topic." }, - "references": { - "$ref": "GoogleMapsPlacesV1References", - "description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. References that are related to this block of content." - }, - "topic": { - "description": "The topic of the content, for example \"overview\" or \"restaurant\".", - "type": "string" + "referencedPlaces": { + "description": "The list of resource names of the referenced places. This name can be used in other APIs that accept Place resource names.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -1034,10 +1033,6 @@ "description": "Place allows dogs.", "type": "boolean" }, - "areaSummary": { - "$ref": "GoogleMapsPlacesV1PlaceAreaSummary", - "description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in." - }, "attributions": { "description": "A set of data provider that must be shown with this result.", "items": { @@ -1099,6 +1094,10 @@ "$ref": "GoogleTypeLocalizedText", "description": "Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered." }, + "evChargeAmenitySummary": { + "$ref": "GoogleMapsPlacesV1PlaceEvChargeAmenitySummary", + "description": "The summary of amenities near the EV charging station." + }, "evChargeOptions": { "$ref": "GoogleMapsPlacesV1EVChargeOptions", "description": "Information of ev charging options." @@ -1113,7 +1112,7 @@ }, "generativeSummary": { "$ref": "GoogleMapsPlacesV1PlaceGenerativeSummary", - "description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the place." + "description": "AI-generated summary of the place." }, "goodForChildren": { "description": "Place is good for children.", @@ -1171,6 +1170,10 @@ "description": "A human-readable phone number for the place, in national format.", "type": "string" }, + "neighborhoodSummary": { + "$ref": "GoogleMapsPlacesV1PlaceNeighborhoodSummary", + "description": "A summary of points of interest near the place." + }, "outdoorSeating": { "description": "Place provides outdoor seating.", "type": "boolean" @@ -1241,7 +1244,7 @@ }, "regularOpeningHours": { "$ref": "GoogleMapsPlacesV1PlaceOpeningHours", - "description": "The regular hours of operation. Note that if a place is always open (24 hours), the `close` field will not be set. Clients can rely on always open (24 hours) being represented as an `open` period containing `day` with value `0`, `hour` with value `0`, and `minute` with value `0`." + "description": "The regular hours of operation. Note that if a place is always open (24 hours), the `close` field will not be set. Clients can rely on always open (24 hours) being represented as an [`open`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Period) period containing [`day`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`, [`hour`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`, and [`minute`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`." }, "regularSecondaryOpeningHours": { "description": "Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place.", @@ -1258,6 +1261,10 @@ "description": "Place has restroom.", "type": "boolean" }, + "reviewSummary": { + "$ref": "GoogleMapsPlacesV1PlaceReviewSummary", + "description": "AI-generated summary of the place using user reviews." + }, "reviews": { "description": "List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned.", "items": { @@ -1310,7 +1317,7 @@ "type": "string" }, "subDestinations": { - "description": "A list of sub destinations related to the place.", + "description": "A list of sub-destinations related to the place.", "items": { "$ref": "GoogleMapsPlacesV1PlaceSubDestination" }, @@ -1401,24 +1408,6 @@ }, "type": "object" }, - "GoogleMapsPlacesV1PlaceAreaSummary": { - "description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in.", - "id": "GoogleMapsPlacesV1PlaceAreaSummary", - "properties": { - "contentBlocks": { - "description": "Content blocks that compose the area summary. Each block has a separate topic about the area.", - "items": { - "$ref": "GoogleMapsPlacesV1ContentBlock" - }, - "type": "array" - }, - "flagContentUri": { - "description": "A link where users can flag a problem with the summary.", - "type": "string" - } - }, - "type": "object" - }, "GoogleMapsPlacesV1PlaceAttribution": { "description": "Information about data providers of this place.", "id": "GoogleMapsPlacesV1PlaceAttribution", @@ -1449,18 +1438,45 @@ }, "type": "object" }, - "GoogleMapsPlacesV1PlaceGenerativeSummary": { - "description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the place.", - "id": "GoogleMapsPlacesV1PlaceGenerativeSummary", + "GoogleMapsPlacesV1PlaceEvChargeAmenitySummary": { + "description": "The summary of amenities near the EV charging station. This only applies to places with type `electric_vehicle_charging_station`. The `overview` field is guaranteed to be provided while the other fields are optional.", + "id": "GoogleMapsPlacesV1PlaceEvChargeAmenitySummary", "properties": { - "description": { + "coffee": { + "$ref": "GoogleMapsPlacesV1ContentBlock", + "description": "A summary of the nearby coffee options." + }, + "disclosureText": { "$ref": "GoogleTypeLocalizedText", - "description": "The detailed description of the place." + "description": "The AI disclosure message \"Summarized with Gemini\" (and its localized variants). This will be in the language specified in the request if available." }, - "descriptionFlagContentUri": { - "description": "A link where users can flag a problem with the description summary.", + "flagContentUri": { + "description": "A link where users can flag a problem with the summary.", "type": "string" }, + "overview": { + "$ref": "GoogleMapsPlacesV1ContentBlock", + "description": "An overview of the available amenities. This is guaranteed to be provided." + }, + "restaurant": { + "$ref": "GoogleMapsPlacesV1ContentBlock", + "description": "A summary of the nearby restaurants." + }, + "store": { + "$ref": "GoogleMapsPlacesV1ContentBlock", + "description": "A summary of the nearby gas stations." + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1PlaceGenerativeSummary": { + "description": "AI-generated summary of the place.", + "id": "GoogleMapsPlacesV1PlaceGenerativeSummary", + "properties": { + "disclosureText": { + "$ref": "GoogleTypeLocalizedText", + "description": "The AI disclosure message \"Summarized with Gemini\" (and its localized variants). This will be in the language specified in the request if available." + }, "overview": { "$ref": "GoogleTypeLocalizedText", "description": "The overview of the place." @@ -1468,10 +1484,6 @@ "overviewFlagContentUri": { "description": "A link where users can flag a problem with the overview summary.", "type": "string" - }, - "references": { - "$ref": "GoogleMapsPlacesV1References", - "description": "References that are used to generate the summary description." } }, "type": "object" @@ -1503,6 +1515,29 @@ }, "type": "object" }, + "GoogleMapsPlacesV1PlaceNeighborhoodSummary": { + "description": "A summary of points of interest near the place.", + "id": "GoogleMapsPlacesV1PlaceNeighborhoodSummary", + "properties": { + "description": { + "$ref": "GoogleMapsPlacesV1ContentBlock", + "description": "A detailed description of the neighborhood." + }, + "disclosureText": { + "$ref": "GoogleTypeLocalizedText", + "description": "The AI disclosure message \"Summarized with Gemini\" (and its localized variants). This will be in the language specified in the request if available." + }, + "flagContentUri": { + "description": "A link where users can flag a problem with the summary.", + "type": "string" + }, + "overview": { + "$ref": "GoogleMapsPlacesV1ContentBlock", + "description": "An overview summary of the neighborhood." + } + }, + "type": "object" + }, "GoogleMapsPlacesV1PlaceOpeningHours": { "description": "Information about business hour of the place.", "id": "GoogleMapsPlacesV1PlaceOpeningHours", @@ -1710,16 +1745,35 @@ }, "type": "object" }, + "GoogleMapsPlacesV1PlaceReviewSummary": { + "description": "AI-generated summary of the place using user reviews.", + "id": "GoogleMapsPlacesV1PlaceReviewSummary", + "properties": { + "disclosureText": { + "$ref": "GoogleTypeLocalizedText", + "description": "The AI disclosure message \"Summarized with Gemini\" (and its localized variants). This will be in the language specified in the request if available." + }, + "flagContentUri": { + "description": "A link where users can flag a problem with the summary.", + "type": "string" + }, + "text": { + "$ref": "GoogleTypeLocalizedText", + "description": "The summary of user reviews." + } + }, + "type": "object" + }, "GoogleMapsPlacesV1PlaceSubDestination": { - "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.", + "description": "Sub-destinations are specific places associated with a main place. These provide more specific destinations for users who are searching within 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": { - "description": "The place id of the sub destination.", + "description": "The place id of the sub-destination.", "type": "string" }, "name": { - "description": "The resource name of the sub destination.", + "description": "The resource name of the sub-destination.", "type": "string" } }, @@ -1751,27 +1805,6 @@ }, "type": "object" }, - "GoogleMapsPlacesV1References": { - "description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Reference that the generative content is related to.", - "id": "GoogleMapsPlacesV1References", - "properties": { - "places": { - "description": "The list of resource names of the referenced places. This name can be used in other APIs that accept Place resource names.", - "items": { - "type": "string" - }, - "type": "array" - }, - "reviews": { - "description": "Reviews that serve as references.", - "items": { - "$ref": "GoogleMapsPlacesV1Review" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleMapsPlacesV1Review": { "description": "Information about a review of a place.", "id": "GoogleMapsPlacesV1Review", @@ -1813,6 +1846,27 @@ "text": { "$ref": "GoogleTypeLocalizedText", "description": "The localized text of the review." + }, + "visitDate": { + "$ref": "GoogleMapsPlacesV1ReviewVisitDate", + "description": "The date when the author visited the place. This is trucated to month." + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1ReviewVisitDate": { + "description": "The date when the author visited the place. This is trucated to month.", + "id": "GoogleMapsPlacesV1ReviewVisitDate", + "properties": { + "month": { + "description": "The month the author visited the place, e.g. 4. The value is between 1 and 12.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "The year the author visited the place, e.g. 2025.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -2332,18 +2386,18 @@ "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", + "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 or 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).", + "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 or 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). In 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.", + "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. 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": { @@ -2351,7 +2405,7 @@ "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.", + "description": "Optional. Generally refers to the city or 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": { @@ -2359,7 +2413,7 @@ "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.).", + "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 or zip code validation in the United States).", "type": "string" }, "recipients": { @@ -2379,11 +2433,11 @@ "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).", + "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\" (Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" } }, diff --git a/discovery/policysimulator-v1.json b/discovery/policysimulator-v1.json index 4991dbaa490..8f985ff3514 100644 --- a/discovery/policysimulator-v1.json +++ b/discovery/policysimulator-v1.json @@ -806,213 +806,9 @@ } } }, - "revision": "20250119", + "revision": "20250323", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { - "GoogleCloudOrgpolicyV2AlternatePolicySpec": { - "description": "Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run.", - "id": "GoogleCloudOrgpolicyV2AlternatePolicySpec", - "properties": { - "launch": { - "description": "Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy.", - "type": "string" - }, - "spec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Specify constraint for configurations of Google Cloud resources." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2CustomConstraint": { - "description": "A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*.", - "id": "GoogleCloudOrgpolicyV2CustomConstraint", - "properties": { - "actionType": { - "description": "Allow or deny type.", - "enum": [ - "ACTION_TYPE_UNSPECIFIED", - "ALLOW", - "DENY" - ], - "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be used. Results in an error.", - "Allowed action type.", - "Deny action type." - ], - "type": "string" - }, - "condition": { - "description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"[production|test]_.*_(\\d)+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", - "type": "string" - }, - "description": { - "description": "Detailed information about this custom policy constraint. The max length of the description is 2000 characters.", - "type": "string" - }, - "displayName": { - "description": "One line display name for the UI. The max length of the display_name is 200 characters.", - "type": "string" - }, - "methodTypes": { - "description": "All the operations being applied for this constraint.", - "items": { - "enum": [ - "METHOD_TYPE_UNSPECIFIED", - "CREATE", - "UPDATE", - "DELETE", - "REMOVE_GRANT", - "GOVERN_TAGS" - ], - "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be used. Results in an error.", - "Constraint applied when creating the resource.", - "Constraint applied when updating the resource.", - "Constraint applied when deleting the resource. Not currently supported.", - "Constraint applied when removing an IAM grant.", - "Constraint applied when enforcing forced tagging." - ], - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", - "type": "string" - }, - "resourceTypes": { - "description": "Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "updateTime": { - "description": "Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` methods were called.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2Policy": { - "description": "Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.", - "id": "GoogleCloudOrgpolicyV2Policy", - "properties": { - "alternate": { - "$ref": "GoogleCloudOrgpolicyV2AlternatePolicySpec", - "deprecated": true, - "description": "Deprecated." - }, - "dryRunSpec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced." - }, - "etag": { - "description": "Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This 'etag' 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" - }, - "name": { - "description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", - "type": "string" - }, - "spec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Basic information about the organization policy." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpec": { - "description": "Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.", - "id": "GoogleCloudOrgpolicyV2PolicySpec", - "properties": { - "etag": { - "description": "An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this `etag` indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset.", - "type": "string" - }, - "inheritFromParent": { - "description": "Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.", - "type": "boolean" - }, - "reset": { - "description": "Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false.", - "type": "boolean" - }, - "rules": { - "description": "In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.", - "items": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule" - }, - "type": "array" - }, - "updateTime": { - "description": "Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpecPolicyRule": { - "description": "A rule used to express this policy.", - "id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule", - "properties": { - "allowAll": { - "description": "Setting this to true means that all values are allowed. This field can be set only in policies for list constraints.", - "type": "boolean" - }, - "condition": { - "$ref": "GoogleTypeExpr", - "description": "A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the \"||\" or \"&&\" operators. Each subexpression must be of the form \"resource.matchTag('/tag_key_short_name, 'tag_value_short_name')\". or \"resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')\". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: \"resource.matchTag('123456789/environment, 'prod')\". or \"resource.matchTagId('tagKeys/123', 'tagValues/456')\"." - }, - "denyAll": { - "description": "Setting this to true means that all values are denied. This field can be set only in policies for list constraints.", - "type": "boolean" - }, - "enforce": { - "description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints.", - "type": "boolean" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" - }, - "values": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues", - "description": "List of values to be used for this policy rule. This field can be set only in policies for list constraints." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues": { - "description": "A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a \":\". Values prefixed with \"is:\" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - `projects/` (for example, `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used.", - "id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues", - "properties": { - "allowedValues": { - "description": "List of values allowed at this resource.", - "items": { - "type": "string" - }, - "type": "array" - }, - "deniedValues": { - "description": "List of values denied at this resource.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudPolicysimulatorV1AccessStateDiff": { "description": "A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple.", "id": "GoogleCloudPolicysimulatorV1AccessStateDiff", @@ -1458,504 +1254,6 @@ }, "type": "object" }, - "GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e., when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e. when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay": { - "description": "The proposed changes to OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", - "properties": { - "customConstraints": { - "description": "Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay" - }, - "type": "array" - }, - "policies": { - "description": "Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay": { - "description": "A change to an OrgPolicy custom constraint.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "Optional. The new or updated custom constraint." - }, - "customConstraintParent": { - "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay": { - "description": "A change to an OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay", - "properties": { - "policy": { - "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "Optional. The new or updated OrgPolicy." - }, - "policyParent": { - "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview": { - "description": "OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview", - "properties": { - "createTime": { - "description": "Output only. Time when this `OrgPolicyViolationsPreview` was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customConstraints": { - "description": "Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "name": { - "description": "Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`", - "readOnly": true, - "type": "string" - }, - "overlay": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", - "description": "Required. The proposed changes we are previewing violations for." - }, - "resourceCounts": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", - "description": "Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "readOnly": true - }, - "state": { - "description": "Output only. The state of the `OrgPolicyViolationsPreview`.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - }, - "violationsCount": { - "description": "Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts": { - "description": "A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", - "properties": { - "compliant": { - "description": "Output only. Number of scanned resources with zero violations.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "errors": { - "description": "Output only. Number of resources that returned an error when scanned.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "noncompliant": { - "description": "Output only. Number of scanned resources with at least one violation.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "scanned": { - "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "unenforced": { - "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e., when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e. when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay": { - "description": "The proposed changes to OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", - "properties": { - "customConstraints": { - "description": "Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay" - }, - "type": "array" - }, - "policies": { - "description": "Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay": { - "description": "A change to an OrgPolicy custom constraint.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "Optional. The new or updated custom constraint." - }, - "customConstraintParent": { - "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay": { - "description": "A change to an OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay", - "properties": { - "policy": { - "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "Optional. The new or updated OrgPolicy." - }, - "policyParent": { - "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview": { - "description": "OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview", - "properties": { - "createTime": { - "description": "Output only. Time when this `OrgPolicyViolationsPreview` was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customConstraints": { - "description": "Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "name": { - "description": "Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`", - "readOnly": true, - "type": "string" - }, - "overlay": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", - "description": "Required. The proposed changes we are previewing violations for." - }, - "resourceCounts": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", - "description": "Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "readOnly": true - }, - "state": { - "description": "Output only. The state of the `OrgPolicyViolationsPreview`.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - }, - "violationsCount": { - "description": "Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts": { - "description": "A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", - "properties": { - "compliant": { - "description": "Output only. Number of scanned resources with zero violations.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "errors": { - "description": "Output only. Number of resources that returned an error when scanned.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "noncompliant": { - "description": "Output only. Number of scanned resources with at least one violation.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "scanned": { - "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "unenforced": { - "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, "GoogleIamV1AuditConfig": { "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": "GoogleIamV1AuditConfig", diff --git a/discovery/policysimulator-v1alpha.json b/discovery/policysimulator-v1alpha.json index 8ea542fbe71..fb12e7bb09c 100644 --- a/discovery/policysimulator-v1alpha.json +++ b/discovery/policysimulator-v1alpha.json @@ -143,97 +143,6 @@ } }, "replays": { - "methods": { - "create": { - "description": "Creates and starts a Replay using the given ReplayConfig.", - "flatPath": "v1alpha/folders/{foldersId}/locations/{locationsId}/replays", - "httpMethod": "POST", - "id": "policysimulator.folders.locations.replays.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/replays", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplay" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified Replay. Each `Replay` is available for at least 7 days.", - "flatPath": "v1alpha/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}", - "httpMethod": "GET", - "id": "policysimulator.folders.locations.replays.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Replay to retrieve, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the `Replay`. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplay" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.", - "flatPath": "v1alpha/folders/{foldersId}/locations/{locationsId}/replays", - "httpMethod": "GET", - "id": "policysimulator.folders.locations.replays.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/replays", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListReplaysResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -304,46 +213,6 @@ ] } } - }, - "results": { - "methods": { - "list": { - "description": "Lists the results of running a Replay.", - "flatPath": "v1alpha/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results", - "httpMethod": "GET", - "id": "policysimulator.folders.locations.replays.results.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/results", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListReplayResultsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -426,130 +295,6 @@ "locations": { "resources": { "orgPolicyViolationsPreviews": { - "methods": { - "create": { - "description": "CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The resources to scan are inferred from these specified changes.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews", - "httpMethod": "POST", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "orgPolicyViolationsPreviewId": { - "description": "Optional. An optional user-specified ID for the OrgPolicyViolationsPreview. If not provided, a random ID will be generated.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/orgPolicyViolationsPreviews", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generate": { - "description": "GenerateOrgPolicyViolationsPreview generates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The resources to scan are inferred from these specified changes.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews:generate", - "httpMethod": "POST", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.generate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/orgPolicyViolationsPreviews:generate", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the OrgPolicyViolationsPreview to get.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 5 items will be returned. The maximum value is 10; values above 10 will be coerced to 10.", - "format": "int32", - "location": "query", - "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 must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent the violations are scoped to. Format: `organizations/{organization}/locations/{location}` Example: `organizations/my-example-org/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/orgPolicyViolationsPreviews", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListOrgPolicyViolationsPreviewsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -579,141 +324,10 @@ ] } } - }, - "orgPolicyViolations": { - "methods": { - "list": { - "description": "ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 50 items 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 call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/orgPolicyViolations", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListOrgPolicyViolationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } }, "replays": { - "methods": { - "create": { - "description": "Creates and starts a Replay using the given ReplayConfig.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays", - "httpMethod": "POST", - "id": "policysimulator.organizations.locations.replays.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/replays", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplay" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified Replay. Each `Replay` is available for at least 7 days.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.replays.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Replay to retrieve, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the `Replay`. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplay" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.replays.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/replays", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListReplaysResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -784,46 +398,6 @@ ] } } - }, - "results": { - "methods": { - "list": { - "description": "Lists the results of running a Replay.", - "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.replays.results.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/results", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListReplayResultsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -869,97 +443,6 @@ } }, "replays": { - "methods": { - "create": { - "description": "Creates and starts a Replay using the given ReplayConfig.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/replays", - "httpMethod": "POST", - "id": "policysimulator.projects.locations.replays.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/replays", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplay" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified Replay. Each `Replay` is available for at least 7 days.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}", - "httpMethod": "GET", - "id": "policysimulator.projects.locations.replays.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Replay to retrieve, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the `Replay`. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplay" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/replays", - "httpMethod": "GET", - "id": "policysimulator.projects.locations.replays.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/replays", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListReplaysResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -1030,46 +513,6 @@ ] } } - }, - "results": { - "methods": { - "list": { - "description": "Lists the results of running a Replay.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results", - "httpMethod": "GET", - "id": "policysimulator.projects.locations.replays.results.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/results", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1alphaListReplayResultsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -1078,213 +521,9 @@ } } }, - "revision": "20250119", + "revision": "20250323", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { - "GoogleCloudOrgpolicyV2AlternatePolicySpec": { - "description": "Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run.", - "id": "GoogleCloudOrgpolicyV2AlternatePolicySpec", - "properties": { - "launch": { - "description": "Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy.", - "type": "string" - }, - "spec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Specify constraint for configurations of Google Cloud resources." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2CustomConstraint": { - "description": "A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*.", - "id": "GoogleCloudOrgpolicyV2CustomConstraint", - "properties": { - "actionType": { - "description": "Allow or deny type.", - "enum": [ - "ACTION_TYPE_UNSPECIFIED", - "ALLOW", - "DENY" - ], - "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be used. Results in an error.", - "Allowed action type.", - "Deny action type." - ], - "type": "string" - }, - "condition": { - "description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"[production|test]_.*_(\\d)+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", - "type": "string" - }, - "description": { - "description": "Detailed information about this custom policy constraint. The max length of the description is 2000 characters.", - "type": "string" - }, - "displayName": { - "description": "One line display name for the UI. The max length of the display_name is 200 characters.", - "type": "string" - }, - "methodTypes": { - "description": "All the operations being applied for this constraint.", - "items": { - "enum": [ - "METHOD_TYPE_UNSPECIFIED", - "CREATE", - "UPDATE", - "DELETE", - "REMOVE_GRANT", - "GOVERN_TAGS" - ], - "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be used. Results in an error.", - "Constraint applied when creating the resource.", - "Constraint applied when updating the resource.", - "Constraint applied when deleting the resource. Not currently supported.", - "Constraint applied when removing an IAM grant.", - "Constraint applied when enforcing forced tagging." - ], - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", - "type": "string" - }, - "resourceTypes": { - "description": "Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "updateTime": { - "description": "Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` methods were called.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2Policy": { - "description": "Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.", - "id": "GoogleCloudOrgpolicyV2Policy", - "properties": { - "alternate": { - "$ref": "GoogleCloudOrgpolicyV2AlternatePolicySpec", - "deprecated": true, - "description": "Deprecated." - }, - "dryRunSpec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced." - }, - "etag": { - "description": "Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This 'etag' 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" - }, - "name": { - "description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", - "type": "string" - }, - "spec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Basic information about the organization policy." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpec": { - "description": "Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.", - "id": "GoogleCloudOrgpolicyV2PolicySpec", - "properties": { - "etag": { - "description": "An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this `etag` indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset.", - "type": "string" - }, - "inheritFromParent": { - "description": "Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.", - "type": "boolean" - }, - "reset": { - "description": "Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false.", - "type": "boolean" - }, - "rules": { - "description": "In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.", - "items": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule" - }, - "type": "array" - }, - "updateTime": { - "description": "Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpecPolicyRule": { - "description": "A rule used to express this policy.", - "id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule", - "properties": { - "allowAll": { - "description": "Setting this to true means that all values are allowed. This field can be set only in policies for list constraints.", - "type": "boolean" - }, - "condition": { - "$ref": "GoogleTypeExpr", - "description": "A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the \"||\" or \"&&\" operators. Each subexpression must be of the form \"resource.matchTag('/tag_key_short_name, 'tag_value_short_name')\". or \"resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')\". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: \"resource.matchTag('123456789/environment, 'prod')\". or \"resource.matchTagId('tagKeys/123', 'tagValues/456')\"." - }, - "denyAll": { - "description": "Setting this to true means that all values are denied. This field can be set only in policies for list constraints.", - "type": "boolean" - }, - "enforce": { - "description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints.", - "type": "boolean" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" - }, - "values": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues", - "description": "List of values to be used for this policy rule. This field can be set only in policies for list constraints." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues": { - "description": "A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a \":\". Values prefixed with \"is:\" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - `projects/` (for example, `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used.", - "id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues", - "properties": { - "allowedValues": { - "description": "List of values allowed at this resource.", - "items": { - "type": "string" - }, - "type": "array" - }, - "deniedValues": { - "description": "List of values denied at this resource.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudPolicysimulatorV1Replay": { "description": "A resource describing a `Replay`, or simulation.", "id": "GoogleCloudPolicysimulatorV1Replay", @@ -1398,1036 +637,6 @@ }, "type": "object" }, - "GoogleCloudPolicysimulatorV1alphaAccessStateDiff": { - "description": "A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple.", - "id": "GoogleCloudPolicysimulatorV1alphaAccessStateDiff", - "properties": { - "accessChange": { - "description": "How the principal's access, specified in the AccessState field, changed between the current (baseline) policies and proposed (simulated) policies.", - "enum": [ - "ACCESS_CHANGE_TYPE_UNSPECIFIED", - "NO_CHANGE", - "UNKNOWN_CHANGE", - "ACCESS_REVOKED", - "ACCESS_GAINED", - "ACCESS_MAYBE_REVOKED", - "ACCESS_MAYBE_GAINED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal's access did not change. This includes the case where both baseline and simulated are UNKNOWN, but the unknown information is equivalent.", - "The principal's access under both the current policies and the proposed policies is `UNKNOWN`, but the unknown information differs between them.", - "The principal had access under the current policies (`GRANTED`), but will no longer have access after the proposed changes (`NOT_GRANTED`).", - "The principal did not have access under the current policies (`NOT_GRANTED`), but will have access after the proposed changes (`GRANTED`).", - "This result can occur for the following reasons: * The principal had access under the current policies (`GRANTED`), but their access after the proposed changes is `UNKNOWN`. * The principal's access under the current policies is `UNKNOWN`, but they will not have access after the proposed changes (`NOT_GRANTED`).", - "This result can occur for the following reasons: * The principal did not have access under the current policies (`NOT_GRANTED`), but their access after the proposed changes is `UNKNOWN`. * The principal's access under the current policies is `UNKNOWN`, but they will have access after the proposed changes (`GRANTED`)." - ], - "type": "string" - }, - "baseline": { - "$ref": "GoogleCloudPolicysimulatorV1alphaExplainedAccess", - "description": "The results of evaluating the access tuple under the current (baseline) policies. If the AccessState couldn't be fully evaluated, this field explains why." - }, - "simulated": { - "$ref": "GoogleCloudPolicysimulatorV1alphaExplainedAccess", - "description": "The results of evaluating the access tuple under the proposed (simulated) policies. If the AccessState couldn't be fully evaluated, this field explains why." - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaAccessTuple": { - "description": "Information about the principal, resource, and permission to check.", - "id": "GoogleCloudPolicysimulatorV1alphaAccessTuple", - "properties": { - "fullResourceName": { - "description": "Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", - "type": "string" - }, - "permission": { - "description": "Required. The IAM permission to check for the specified principal and resource. For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", - "type": "string" - }, - "principal": { - "description": "Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaBindingExplanation": { - "description": "Details about how a binding in a policy affects a principal's ability to use a permission.", - "id": "GoogleCloudPolicysimulatorV1alphaBindingExplanation", - "properties": { - "access": { - "description": "Required. Indicates whether _this binding_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the principal actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse.", - "enum": [ - "ACCESS_STATE_UNSPECIFIED", - "GRANTED", - "NOT_GRANTED", - "UNKNOWN_CONDITIONAL", - "UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal has the permission.", - "The principal does not have the permission.", - "The principal has the permission only if a condition expression evaluates to `true`.", - "The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate." - ], - "type": "string" - }, - "condition": { - "$ref": "GoogleTypeExpr", - "description": "A condition expression that prevents this binding from granting access unless the expression evaluates to `true`. To learn about IAM Conditions, see https://cloud.google.com/iam/docs/conditions-overview." - }, - "memberships": { - "additionalProperties": { - "$ref": "GoogleCloudPolicysimulatorV1alphaBindingExplanationAnnotatedMembership" - }, - "description": "Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` The principal in the replayed access tuple is `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal in the binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the second principal in the binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`.", - "type": "object" - }, - "relevance": { - "description": "The relevance of this binding to the overall determination for the entire policy.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - }, - "role": { - "description": "The role that this binding grants. For example, `roles/compute.serviceAgent`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", - "type": "string" - }, - "rolePermission": { - "description": "Indicates whether the role granted by this binding contains the specified permission.", - "enum": [ - "ROLE_PERMISSION_UNSPECIFIED", - "ROLE_PERMISSION_INCLUDED", - "ROLE_PERMISSION_NOT_INCLUDED", - "ROLE_PERMISSION_UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The permission is included in the role.", - "The permission is not included in the role.", - "The user who created the Replay is not allowed to access the binding." - ], - "type": "string" - }, - "rolePermissionRelevance": { - "description": "The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaBindingExplanationAnnotatedMembership": { - "description": "Details about whether the binding includes the principal.", - "id": "GoogleCloudPolicysimulatorV1alphaBindingExplanationAnnotatedMembership", - "properties": { - "membership": { - "description": "Indicates whether the binding includes the principal.", - "enum": [ - "MEMBERSHIP_UNSPECIFIED", - "MEMBERSHIP_INCLUDED", - "MEMBERSHIP_NOT_INCLUDED", - "MEMBERSHIP_UNKNOWN_INFO_DENIED", - "MEMBERSHIP_UNKNOWN_UNSUPPORTED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The binding includes the principal. The principal can be included directly or indirectly. For example: * A principal is included directly if that principal is listed in the binding. * A principal is included indirectly if that principal is in a Google group or Google Workspace domain that is listed in the binding.", - "The binding does not include the principal.", - "The user who created the Replay is not allowed to access the binding.", - "The principal is an unsupported type. Only Google Accounts and service accounts are supported." - ], - "type": "string" - }, - "relevance": { - "description": "The relevance of the principal's status to the overall determination for the binding.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e., when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaExplainedAccess": { - "description": "Details about how a set of policies, listed in ExplainedPolicy, resulted in a certain AccessState when replaying an access tuple.", - "id": "GoogleCloudPolicysimulatorV1alphaExplainedAccess", - "properties": { - "accessState": { - "description": "Whether the principal in the access tuple has permission to access the resource in the access tuple under the given policies.", - "enum": [ - "ACCESS_STATE_UNSPECIFIED", - "GRANTED", - "NOT_GRANTED", - "UNKNOWN_CONDITIONAL", - "UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal has the permission.", - "The principal does not have the permission.", - "The principal has the permission only if a condition expression evaluates to `true`.", - "The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate." - ], - "type": "string" - }, - "errors": { - "description": "If the AccessState is `UNKNOWN`, this field contains a list of errors explaining why the result is `UNKNOWN`. If the `AccessState` is `GRANTED` or `NOT_GRANTED`, this field is omitted.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "policies": { - "description": "If the AccessState is `UNKNOWN`, this field contains the policies that led to that result. If the `AccessState` is `GRANTED` or `NOT_GRANTED`, this field is omitted.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaExplainedPolicy" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaExplainedPolicy": { - "description": "Details about how a specific IAM Policy contributed to the access check.", - "id": "GoogleCloudPolicysimulatorV1alphaExplainedPolicy", - "properties": { - "access": { - "description": "Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse.", - "enum": [ - "ACCESS_STATE_UNSPECIFIED", - "GRANTED", - "NOT_GRANTED", - "UNKNOWN_CONDITIONAL", - "UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal has the permission.", - "The principal does not have the permission.", - "The principal has the permission only if a condition expression evaluates to `true`.", - "The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate." - ], - "type": "string" - }, - "bindingExplanations": { - "description": "Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource. If the user who created the Replay does not have access to the policy, this field is omitted.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaBindingExplanation" - }, - "type": "array" - }, - "fullResourceName": { - "description": "The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the user who created the Replay does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", - "type": "string" - }, - "policy": { - "$ref": "GoogleIamV1Policy", - "description": "The IAM policy attached to the resource. If the user who created the Replay does not have access to the policy, this field is empty." - }, - "relevance": { - "description": "The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the user who created the Replay does not have access to the policy, this field is omitted.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e. when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaListOrgPolicyViolationsPreviewsResponse": { - "description": "ListOrgPolicyViolationsPreviewsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews.", - "id": "GoogleCloudPolicysimulatorV1alphaListOrgPolicyViolationsPreviewsResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "orgPolicyViolationsPreviews": { - "description": "The list of OrgPolicyViolationsPreview", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaListOrgPolicyViolationsResponse": { - "description": "ListOrgPolicyViolationsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolations", - "id": "GoogleCloudPolicysimulatorV1alphaListOrgPolicyViolationsResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "orgPolicyViolations": { - "description": "The list of OrgPolicyViolations", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolation" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaListReplayResultsResponse": { - "description": "Response message for Simulator.ListReplayResults.", - "id": "GoogleCloudPolicysimulatorV1alphaListReplayResultsResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of ReplayResult objects. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "replayResults": { - "description": "The results of running a Replay.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplayResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaListReplaysResponse": { - "description": "Response message for Simulator.ListReplays.", - "id": "GoogleCloudPolicysimulatorV1alphaListReplaysResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "replays": { - "description": "The list of Replay objects.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay": { - "description": "The proposed changes to OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", - "properties": { - "customConstraints": { - "description": "Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay" - }, - "type": "array" - }, - "policies": { - "description": "Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay": { - "description": "A change to an OrgPolicy custom constraint.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "Optional. The new or updated custom constraint." - }, - "customConstraintParent": { - "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay": { - "description": "A change to an OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay", - "properties": { - "policy": { - "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "Optional. The new or updated OrgPolicy." - }, - "policyParent": { - "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolation": { - "description": "OrgPolicyViolation is a resource representing a single resource violating a single OrgPolicy constraint.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolation", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The custom constraint being violated." - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Any error encountered during the evaluation." - }, - "name": { - "description": "The name of the `OrgPolicyViolation`. Example: organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce`", - "type": "string" - }, - "resource": { - "$ref": "GoogleCloudPolicysimulatorV1alphaResourceContext", - "description": "The resource violating the constraint." - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview": { - "description": "OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview", - "properties": { - "createTime": { - "description": "Output only. Time when this `OrgPolicyViolationsPreview` was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customConstraints": { - "description": "Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "name": { - "description": "Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`", - "readOnly": true, - "type": "string" - }, - "overlay": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", - "description": "Required. The proposed changes we are previewing violations for." - }, - "resourceCounts": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", - "description": "Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "readOnly": true - }, - "state": { - "description": "Output only. The state of the `OrgPolicyViolationsPreview`.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - }, - "violationsCount": { - "description": "Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts": { - "description": "A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", - "properties": { - "compliant": { - "description": "Output only. Number of scanned resources with zero violations.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "errors": { - "description": "Output only. Number of resources that returned an error when scanned.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "noncompliant": { - "description": "Output only. Number of scanned resources with at least one violation.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "scanned": { - "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "unenforced": { - "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaReplay": { - "description": "A resource describing a `Replay`, or simulation.", - "id": "GoogleCloudPolicysimulatorV1alphaReplay", - "properties": { - "config": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplayConfig", - "description": "Required. The configuration used for the `Replay`." - }, - "name": { - "description": "Output only. The resource name of the `Replay`, which has the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "readOnly": true, - "type": "string" - }, - "resultsSummary": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplayResultsSummary", - "description": "Output only. Summary statistics about the replayed log entries.", - "readOnly": true - }, - "state": { - "description": "Output only. The current state of the `Replay`.", - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The `Replay` has not started yet.", - "The `Replay` is currently running.", - "The `Replay` has successfully completed.", - "The `Replay` has finished with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaReplayConfig": { - "description": "The configuration used for a Replay.", - "id": "GoogleCloudPolicysimulatorV1alphaReplayConfig", - "properties": { - "logSource": { - "description": "The logs to use as input for the Replay.", - "enum": [ - "LOG_SOURCE_UNSPECIFIED", - "RECENT_ACCESSES" - ], - "enumDescriptions": [ - "An unspecified log source. If the log source is unspecified, the Replay defaults to using `RECENT_ACCESSES`.", - "All access logs from the last 90 days. These logs may not include logs from the most recent 7 days." - ], - "type": "string" - }, - "policyOverlay": { - "additionalProperties": { - "$ref": "GoogleIamV1Policy" - }, - "description": "A mapping of the resources that you want to simulate policies for and the policies that you want to simulate. Keys are the full resource names for the resources. For example, `//cloudresourcemanager.googleapis.com/projects/my-project`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. Values are Policy objects representing the policies that you want to simulate. Replays automatically take into account any IAM policies inherited through the resource hierarchy, and any policies set on descendant resources. You do not need to include these policies in the policy overlay.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaReplayDiff": { - "description": "The difference between the results of evaluating an access tuple under the current (baseline) policies and under the proposed (simulated) policies. This difference explains how a principal's access could change if the proposed policies were applied.", - "id": "GoogleCloudPolicysimulatorV1alphaReplayDiff", - "properties": { - "accessDiff": { - "$ref": "GoogleCloudPolicysimulatorV1alphaAccessStateDiff", - "description": "A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple. The evaluation of the principal's access is reported in the AccessState field." - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaReplayResult": { - "description": "The result of replaying a single access tuple against a simulated state.", - "id": "GoogleCloudPolicysimulatorV1alphaReplayResult", - "properties": { - "accessTuple": { - "$ref": "GoogleCloudPolicysimulatorV1alphaAccessTuple", - "description": "The access tuple that was replayed. This field includes information about the principal, resource, and permission that were involved in the access attempt." - }, - "diff": { - "$ref": "GoogleCloudPolicysimulatorV1alphaReplayDiff", - "description": "The difference between the principal's access under the current (baseline) policies and the principal's access under the proposed (simulated) policies. This field is only included for access tuples that were successfully replayed and had different results under the current policies and the proposed policies." - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "The error that caused the access tuple replay to fail. This field is only included for access tuples that were not replayed successfully." - }, - "lastSeenDate": { - "$ref": "GoogleTypeDate", - "description": "The latest date this access tuple was seen in the logs." - }, - "name": { - "description": "The resource name of the `ReplayResult`, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234`", - "type": "string" - }, - "parent": { - "description": "The Replay that the access tuple was included in.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaReplayResultsSummary": { - "description": "Summary statistics about the replayed log entries.", - "id": "GoogleCloudPolicysimulatorV1alphaReplayResultsSummary", - "properties": { - "differenceCount": { - "description": "The number of replayed log entries with a difference between baseline and simulated policies.", - "format": "int32", - "type": "integer" - }, - "errorCount": { - "description": "The number of log entries that could not be replayed.", - "format": "int32", - "type": "integer" - }, - "logCount": { - "description": "The total number of log entries replayed.", - "format": "int32", - "type": "integer" - }, - "newestDate": { - "$ref": "GoogleTypeDate", - "description": "The date of the newest log entry replayed." - }, - "oldestDate": { - "$ref": "GoogleTypeDate", - "description": "The date of the oldest log entry replayed." - }, - "unchangedCount": { - "description": "The number of replayed log entries with no difference between baseline and simulated policies.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaResourceContext": { - "description": "ResourceContext provides the context we know about a resource. It is similar in concept to google.cloud.asset.v1.Resource, but focuses on the information specifically used by Simulator.", - "id": "GoogleCloudPolicysimulatorV1alphaResourceContext", - "properties": { - "ancestors": { - "description": "The ancestry path of the resource in Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the resource is a project, folder, or organization, the ancestry path starts from the resource itself. Example: `[\"projects/123456789\", \"folders/5432\", \"organizations/1234\"]`", - "items": { - "type": "string" - }, - "type": "array" - }, - "assetType": { - "description": "The asset type of the resource as defined by CAIS. Example: `compute.googleapis.com/Firewall` See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information.", - "type": "string" - }, - "resource": { - "description": "The full name of the resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` See [Resource names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e., when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e. when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay": { - "description": "The proposed changes to OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", - "properties": { - "customConstraints": { - "description": "Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay" - }, - "type": "array" - }, - "policies": { - "description": "Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay": { - "description": "A change to an OrgPolicy custom constraint.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "Optional. The new or updated custom constraint." - }, - "customConstraintParent": { - "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay": { - "description": "A change to an OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay", - "properties": { - "policy": { - "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "Optional. The new or updated OrgPolicy." - }, - "policyParent": { - "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview": { - "description": "OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview", - "properties": { - "createTime": { - "description": "Output only. Time when this `OrgPolicyViolationsPreview` was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customConstraints": { - "description": "Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "name": { - "description": "Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`", - "readOnly": true, - "type": "string" - }, - "overlay": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", - "description": "Required. The proposed changes we are previewing violations for." - }, - "resourceCounts": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", - "description": "Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "readOnly": true - }, - "state": { - "description": "Output only. The state of the `OrgPolicyViolationsPreview`.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - }, - "violationsCount": { - "description": "Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts": { - "description": "A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", - "properties": { - "compliant": { - "description": "Output only. Number of scanned resources with zero violations.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "errors": { - "description": "Output only. Number of resources that returned an error when scanned.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "noncompliant": { - "description": "Output only. Number of scanned resources with at least one violation.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "scanned": { - "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "unenforced": { - "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, "GoogleIamV1AuditConfig": { "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": "GoogleIamV1AuditConfig", diff --git a/discovery/policysimulator-v1beta.json b/discovery/policysimulator-v1beta.json index f35fb69b8e2..98f815ef647 100644 --- a/discovery/policysimulator-v1beta.json +++ b/discovery/policysimulator-v1beta.json @@ -143,97 +143,6 @@ } }, "replays": { - "methods": { - "create": { - "description": "Creates and starts a Replay using the given ReplayConfig.", - "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/replays", - "httpMethod": "POST", - "id": "policysimulator.folders.locations.replays.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/replays", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplay" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified Replay. Each `Replay` is available for at least 7 days.", - "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}", - "httpMethod": "GET", - "id": "policysimulator.folders.locations.replays.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Replay to retrieve, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the `Replay`. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplay" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.", - "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/replays", - "httpMethod": "GET", - "id": "policysimulator.folders.locations.replays.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/replays", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListReplaysResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -304,46 +213,6 @@ ] } } - }, - "results": { - "methods": { - "list": { - "description": "Lists the results of running a Replay.", - "flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results", - "httpMethod": "GET", - "id": "policysimulator.folders.locations.replays.results.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/results", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListReplayResultsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -426,130 +295,6 @@ "locations": { "resources": { "orgPolicyViolationsPreviews": { - "methods": { - "create": { - "description": "CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The resources to scan are inferred from these specified changes.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews", - "httpMethod": "POST", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "orgPolicyViolationsPreviewId": { - "description": "Optional. An optional user-specified ID for the OrgPolicyViolationsPreview. If not provided, a random ID will be generated.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/orgPolicyViolationsPreviews", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generate": { - "description": "GenerateOrgPolicyViolationsPreview generates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The resources to scan are inferred from these specified changes.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews:generate", - "httpMethod": "POST", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.generate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/orgPolicyViolationsPreviews:generate", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the OrgPolicyViolationsPreview to get.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 5 items will be returned. The maximum value is 10; values above 10 will be coerced to 10.", - "format": "int32", - "location": "query", - "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 must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent the violations are scoped to. Format: `organizations/{organization}/locations/{location}` Example: `organizations/my-example-org/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/orgPolicyViolationsPreviews", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListOrgPolicyViolationsPreviewsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -579,141 +324,10 @@ ] } } - }, - "orgPolicyViolations": { - "methods": { - "list": { - "description": "ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 50 items 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 call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/orgPolicyViolations", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListOrgPolicyViolationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } }, "replays": { - "methods": { - "create": { - "description": "Creates and starts a Replay using the given ReplayConfig.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/replays", - "httpMethod": "POST", - "id": "policysimulator.organizations.locations.replays.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/replays", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplay" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified Replay. Each `Replay` is available for at least 7 days.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.replays.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Replay to retrieve, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the `Replay`. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplay" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/replays", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.replays.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/replays", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListReplaysResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -784,46 +398,6 @@ ] } } - }, - "results": { - "methods": { - "list": { - "description": "Lists the results of running a Replay.", - "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results", - "httpMethod": "GET", - "id": "policysimulator.organizations.locations.replays.results.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/results", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListReplayResultsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -869,97 +443,6 @@ } }, "replays": { - "methods": { - "create": { - "description": "Creates and starts a Replay using the given ReplayConfig.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/replays", - "httpMethod": "POST", - "id": "policysimulator.projects.locations.replays.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: `projects/my-example-project/locations/global`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/replays", - "request": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplay" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified Replay. Each `Replay` is available for at least 7 days.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}", - "httpMethod": "GET", - "id": "policysimulator.projects.locations.replays.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Replay to retrieve, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the `Replay`. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplay" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists each Replay in a project, folder, or organization. Each `Replay` is available for at least 7 days.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/replays", - "httpMethod": "GET", - "id": "policysimulator.projects.locations.replays.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of Replay objects to return. Defaults to 50. The maximum value is 1000; values above 1000 are rounded down to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplays call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to Simulator.ListReplays must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global` Only `Replay` objects that are direct children of the provided parent are listed. In other words, `Replay` objects that are children of a project will not be included when the parent is a folder of that project.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/replays", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListReplaysResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "operations": { "methods": { @@ -1030,46 +513,6 @@ ] } } - }, - "results": { - "methods": { - "list": { - "description": "Lists the results of running a Replay.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results", - "httpMethod": "GET", - "id": "policysimulator.projects.locations.replays.results.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Replay whose results are listed, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}` Example: `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/replays/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/results", - "response": { - "$ref": "GoogleCloudPolicysimulatorV1betaListReplayResultsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -1078,213 +521,9 @@ } } }, - "revision": "20250119", + "revision": "20250323", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { - "GoogleCloudOrgpolicyV2AlternatePolicySpec": { - "description": "Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run.", - "id": "GoogleCloudOrgpolicyV2AlternatePolicySpec", - "properties": { - "launch": { - "description": "Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy.", - "type": "string" - }, - "spec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Specify constraint for configurations of Google Cloud resources." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2CustomConstraint": { - "description": "A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*.", - "id": "GoogleCloudOrgpolicyV2CustomConstraint", - "properties": { - "actionType": { - "description": "Allow or deny type.", - "enum": [ - "ACTION_TYPE_UNSPECIFIED", - "ALLOW", - "DENY" - ], - "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be used. Results in an error.", - "Allowed action type.", - "Deny action type." - ], - "type": "string" - }, - "condition": { - "description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"[production|test]_.*_(\\d)+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", - "type": "string" - }, - "description": { - "description": "Detailed information about this custom policy constraint. The max length of the description is 2000 characters.", - "type": "string" - }, - "displayName": { - "description": "One line display name for the UI. The max length of the display_name is 200 characters.", - "type": "string" - }, - "methodTypes": { - "description": "All the operations being applied for this constraint.", - "items": { - "enum": [ - "METHOD_TYPE_UNSPECIFIED", - "CREATE", - "UPDATE", - "DELETE", - "REMOVE_GRANT", - "GOVERN_TAGS" - ], - "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be used. Results in an error.", - "Constraint applied when creating the resource.", - "Constraint applied when updating the resource.", - "Constraint applied when deleting the resource. Not currently supported.", - "Constraint applied when removing an IAM grant.", - "Constraint applied when enforcing forced tagging." - ], - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", - "type": "string" - }, - "resourceTypes": { - "description": "Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "updateTime": { - "description": "Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` methods were called.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2Policy": { - "description": "Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.", - "id": "GoogleCloudOrgpolicyV2Policy", - "properties": { - "alternate": { - "$ref": "GoogleCloudOrgpolicyV2AlternatePolicySpec", - "deprecated": true, - "description": "Deprecated." - }, - "dryRunSpec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced." - }, - "etag": { - "description": "Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This 'etag' 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" - }, - "name": { - "description": "Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.", - "type": "string" - }, - "spec": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpec", - "description": "Basic information about the organization policy." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpec": { - "description": "Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.", - "id": "GoogleCloudOrgpolicyV2PolicySpec", - "properties": { - "etag": { - "description": "An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this `etag` indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset.", - "type": "string" - }, - "inheritFromParent": { - "description": "Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.", - "type": "boolean" - }, - "reset": { - "description": "Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false.", - "type": "boolean" - }, - "rules": { - "description": "In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.", - "items": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule" - }, - "type": "array" - }, - "updateTime": { - "description": "Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpecPolicyRule": { - "description": "A rule used to express this policy.", - "id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRule", - "properties": { - "allowAll": { - "description": "Setting this to true means that all values are allowed. This field can be set only in policies for list constraints.", - "type": "boolean" - }, - "condition": { - "$ref": "GoogleTypeExpr", - "description": "A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the \"||\" or \"&&\" operators. Each subexpression must be of the form \"resource.matchTag('/tag_key_short_name, 'tag_value_short_name')\". or \"resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')\". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: \"resource.matchTag('123456789/environment, 'prod')\". or \"resource.matchTagId('tagKeys/123', 'tagValues/456')\"." - }, - "denyAll": { - "description": "Setting this to true means that all values are denied. This field can be set only in policies for list constraints.", - "type": "boolean" - }, - "enforce": { - "description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints.", - "type": "boolean" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" - }, - "values": { - "$ref": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues", - "description": "List of values to be used for this policy rule. This field can be set only in policies for list constraints." - } - }, - "type": "object" - }, - "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues": { - "description": "A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a \":\". Values prefixed with \"is:\" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - `projects/` (for example, `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used.", - "id": "GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues", - "properties": { - "allowedValues": { - "description": "List of values allowed at this resource.", - "items": { - "type": "string" - }, - "type": "array" - }, - "deniedValues": { - "description": "List of values denied at this resource.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudPolicysimulatorV1Replay": { "description": "A resource describing a `Replay`, or simulation.", "id": "GoogleCloudPolicysimulatorV1Replay", @@ -1398,1036 +637,6 @@ }, "type": "object" }, - "GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e., when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e. when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay": { - "description": "The proposed changes to OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", - "properties": { - "customConstraints": { - "description": "Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay" - }, - "type": "array" - }, - "policies": { - "description": "Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay": { - "description": "A change to an OrgPolicy custom constraint.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "Optional. The new or updated custom constraint." - }, - "customConstraintParent": { - "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay": { - "description": "A change to an OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay", - "properties": { - "policy": { - "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "Optional. The new or updated OrgPolicy." - }, - "policyParent": { - "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview": { - "description": "OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview", - "properties": { - "createTime": { - "description": "Output only. Time when this `OrgPolicyViolationsPreview` was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customConstraints": { - "description": "Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "name": { - "description": "Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`", - "readOnly": true, - "type": "string" - }, - "overlay": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay", - "description": "Required. The proposed changes we are previewing violations for." - }, - "resourceCounts": { - "$ref": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", - "description": "Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "readOnly": true - }, - "state": { - "description": "Output only. The state of the `OrgPolicyViolationsPreview`.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - }, - "violationsCount": { - "description": "Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts": { - "description": "A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts", - "properties": { - "compliant": { - "description": "Output only. Number of scanned resources with zero violations.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "errors": { - "description": "Output only. Number of resources that returned an error when scanned.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "noncompliant": { - "description": "Output only. Number of scanned resources with at least one violation.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "scanned": { - "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "unenforced": { - "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaAccessStateDiff": { - "description": "A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple.", - "id": "GoogleCloudPolicysimulatorV1betaAccessStateDiff", - "properties": { - "accessChange": { - "description": "How the principal's access, specified in the AccessState field, changed between the current (baseline) policies and proposed (simulated) policies.", - "enum": [ - "ACCESS_CHANGE_TYPE_UNSPECIFIED", - "NO_CHANGE", - "UNKNOWN_CHANGE", - "ACCESS_REVOKED", - "ACCESS_GAINED", - "ACCESS_MAYBE_REVOKED", - "ACCESS_MAYBE_GAINED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal's access did not change. This includes the case where both baseline and simulated are UNKNOWN, but the unknown information is equivalent.", - "The principal's access under both the current policies and the proposed policies is `UNKNOWN`, but the unknown information differs between them.", - "The principal had access under the current policies (`GRANTED`), but will no longer have access after the proposed changes (`NOT_GRANTED`).", - "The principal did not have access under the current policies (`NOT_GRANTED`), but will have access after the proposed changes (`GRANTED`).", - "This result can occur for the following reasons: * The principal had access under the current policies (`GRANTED`), but their access after the proposed changes is `UNKNOWN`. * The principal's access under the current policies is `UNKNOWN`, but they will not have access after the proposed changes (`NOT_GRANTED`).", - "This result can occur for the following reasons: * The principal did not have access under the current policies (`NOT_GRANTED`), but their access after the proposed changes is `UNKNOWN`. * The principal's access under the current policies is `UNKNOWN`, but they will have access after the proposed changes (`GRANTED`)." - ], - "type": "string" - }, - "baseline": { - "$ref": "GoogleCloudPolicysimulatorV1betaExplainedAccess", - "description": "The results of evaluating the access tuple under the current (baseline) policies. If the AccessState couldn't be fully evaluated, this field explains why." - }, - "simulated": { - "$ref": "GoogleCloudPolicysimulatorV1betaExplainedAccess", - "description": "The results of evaluating the access tuple under the proposed (simulated) policies. If the AccessState couldn't be fully evaluated, this field explains why." - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaAccessTuple": { - "description": "Information about the principal, resource, and permission to check.", - "id": "GoogleCloudPolicysimulatorV1betaAccessTuple", - "properties": { - "fullResourceName": { - "description": "Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", - "type": "string" - }, - "permission": { - "description": "Required. The IAM permission to check for the specified principal and resource. For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", - "type": "string" - }, - "principal": { - "description": "Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaBindingExplanation": { - "description": "Details about how a binding in a policy affects a principal's ability to use a permission.", - "id": "GoogleCloudPolicysimulatorV1betaBindingExplanation", - "properties": { - "access": { - "description": "Required. Indicates whether _this binding_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the principal actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse.", - "enum": [ - "ACCESS_STATE_UNSPECIFIED", - "GRANTED", - "NOT_GRANTED", - "UNKNOWN_CONDITIONAL", - "UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal has the permission.", - "The principal does not have the permission.", - "The principal has the permission only if a condition expression evaluates to `true`.", - "The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate." - ], - "type": "string" - }, - "condition": { - "$ref": "GoogleTypeExpr", - "description": "A condition expression that prevents this binding from granting access unless the expression evaluates to `true`. To learn about IAM Conditions, see https://cloud.google.com/iam/docs/conditions-overview." - }, - "memberships": { - "additionalProperties": { - "$ref": "GoogleCloudPolicysimulatorV1betaBindingExplanationAnnotatedMembership" - }, - "description": "Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` The principal in the replayed access tuple is `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal in the binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the second principal in the binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`.", - "type": "object" - }, - "relevance": { - "description": "The relevance of this binding to the overall determination for the entire policy.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - }, - "role": { - "description": "The role that this binding grants. For example, `roles/compute.serviceAgent`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", - "type": "string" - }, - "rolePermission": { - "description": "Indicates whether the role granted by this binding contains the specified permission.", - "enum": [ - "ROLE_PERMISSION_UNSPECIFIED", - "ROLE_PERMISSION_INCLUDED", - "ROLE_PERMISSION_NOT_INCLUDED", - "ROLE_PERMISSION_UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The permission is included in the role.", - "The permission is not included in the role.", - "The user who created the Replay is not allowed to access the binding." - ], - "type": "string" - }, - "rolePermissionRelevance": { - "description": "The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaBindingExplanationAnnotatedMembership": { - "description": "Details about whether the binding includes the principal.", - "id": "GoogleCloudPolicysimulatorV1betaBindingExplanationAnnotatedMembership", - "properties": { - "membership": { - "description": "Indicates whether the binding includes the principal.", - "enum": [ - "MEMBERSHIP_UNSPECIFIED", - "MEMBERSHIP_INCLUDED", - "MEMBERSHIP_NOT_INCLUDED", - "MEMBERSHIP_UNKNOWN_INFO_DENIED", - "MEMBERSHIP_UNKNOWN_UNSUPPORTED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The binding includes the principal. The principal can be included directly or indirectly. For example: * A principal is included directly if that principal is listed in the binding. * A principal is included indirectly if that principal is in a Google group or Google Workspace domain that is listed in the binding.", - "The binding does not include the principal.", - "The user who created the Replay is not allowed to access the binding.", - "The principal is an unsupported type. Only Google Accounts and service accounts are supported." - ], - "type": "string" - }, - "relevance": { - "description": "The relevance of the principal's status to the overall determination for the binding.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e., when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaExplainedAccess": { - "description": "Details about how a set of policies, listed in ExplainedPolicy, resulted in a certain AccessState when replaying an access tuple.", - "id": "GoogleCloudPolicysimulatorV1betaExplainedAccess", - "properties": { - "accessState": { - "description": "Whether the principal in the access tuple has permission to access the resource in the access tuple under the given policies.", - "enum": [ - "ACCESS_STATE_UNSPECIFIED", - "GRANTED", - "NOT_GRANTED", - "UNKNOWN_CONDITIONAL", - "UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal has the permission.", - "The principal does not have the permission.", - "The principal has the permission only if a condition expression evaluates to `true`.", - "The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate." - ], - "type": "string" - }, - "errors": { - "description": "If the AccessState is `UNKNOWN`, this field contains a list of errors explaining why the result is `UNKNOWN`. If the `AccessState` is `GRANTED` or `NOT_GRANTED`, this field is omitted.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "policies": { - "description": "If the AccessState is `UNKNOWN`, this field contains the policies that led to that result. If the `AccessState` is `GRANTED` or `NOT_GRANTED`, this field is omitted.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaExplainedPolicy" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaExplainedPolicy": { - "description": "Details about how a specific IAM Policy contributed to the access check.", - "id": "GoogleCloudPolicysimulatorV1betaExplainedPolicy", - "properties": { - "access": { - "description": "Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse.", - "enum": [ - "ACCESS_STATE_UNSPECIFIED", - "GRANTED", - "NOT_GRANTED", - "UNKNOWN_CONDITIONAL", - "UNKNOWN_INFO_DENIED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The principal has the permission.", - "The principal does not have the permission.", - "The principal has the permission only if a condition expression evaluates to `true`.", - "The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate." - ], - "type": "string" - }, - "bindingExplanations": { - "description": "Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource. If the user who created the Replay does not have access to the policy, this field is omitted.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaBindingExplanation" - }, - "type": "array" - }, - "fullResourceName": { - "description": "The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the user who created the Replay does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", - "type": "string" - }, - "policy": { - "$ref": "GoogleIamV1Policy", - "description": "The IAM policy attached to the resource. If the user who created the Replay does not have access to the policy, this field is empty." - }, - "relevance": { - "description": "The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the user who created the Replay does not have access to the policy, this field is omitted.", - "enum": [ - "HEURISTIC_RELEVANCE_UNSPECIFIED", - "NORMAL", - "HIGH" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", - "The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata": { - "description": "GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.", - "id": "GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata", - "properties": { - "requestTime": { - "description": "Time when the request was received.", - "format": "google-datetime", - "type": "string" - }, - "resourcesFound": { - "description": "Total number of resources that need scanning. Should equal resource_scanned + resources_pending", - "format": "int32", - "type": "integer" - }, - "resourcesPending": { - "description": "Number of resources still to scan.", - "format": "int32", - "type": "integer" - }, - "resourcesScanned": { - "description": "Number of resources already scanned.", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time when the request started processing, i.e. when the state was set to RUNNING.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The current state of the operation.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaListOrgPolicyViolationsPreviewsResponse": { - "description": "ListOrgPolicyViolationsPreviewsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews.", - "id": "GoogleCloudPolicysimulatorV1betaListOrgPolicyViolationsPreviewsResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "orgPolicyViolationsPreviews": { - "description": "The list of OrgPolicyViolationsPreview", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaListOrgPolicyViolationsResponse": { - "description": "ListOrgPolicyViolationsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolations", - "id": "GoogleCloudPolicysimulatorV1betaListOrgPolicyViolationsResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "orgPolicyViolations": { - "description": "The list of OrgPolicyViolations", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolation" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaListReplayResultsResponse": { - "description": "Response message for Simulator.ListReplayResults.", - "id": "GoogleCloudPolicysimulatorV1betaListReplayResultsResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of ReplayResult objects. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "replayResults": { - "description": "The results of running a Replay.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplayResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaListReplaysResponse": { - "description": "Response message for Simulator.ListReplays.", - "id": "GoogleCloudPolicysimulatorV1betaListReplaysResponse", - "properties": { - "nextPageToken": { - "description": "A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "replays": { - "description": "The list of Replay objects.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay": { - "description": "The proposed changes to OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", - "properties": { - "customConstraints": { - "description": "Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay" - }, - "type": "array" - }, - "policies": { - "description": "Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated.", - "items": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay": { - "description": "A change to an OrgPolicy custom constraint.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "Optional. The new or updated custom constraint." - }, - "customConstraintParent": { - "description": "Optional. Resource the constraint is attached to. Example: \"organization/987654\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay": { - "description": "A change to an OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay", - "properties": { - "policy": { - "$ref": "GoogleCloudOrgpolicyV2Policy", - "description": "Optional. The new or updated OrgPolicy." - }, - "policyParent": { - "description": "Optional. The parent of the policy we are attaching to. Example: \"projects/123456\"", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyViolation": { - "description": "OrgPolicyViolation is a resource representing a single resource violating a single OrgPolicy constraint.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolation", - "properties": { - "customConstraint": { - "$ref": "GoogleCloudOrgpolicyV2CustomConstraint", - "description": "The custom constraint being violated." - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Any error encountered during the evaluation." - }, - "name": { - "description": "The name of the `OrgPolicyViolation`. Example: organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce`", - "type": "string" - }, - "resource": { - "$ref": "GoogleCloudPolicysimulatorV1betaResourceContext", - "description": "The resource violating the constraint." - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview": { - "description": "OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview", - "properties": { - "createTime": { - "description": "Output only. Time when this `OrgPolicyViolationsPreview` was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customConstraints": { - "description": "Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "name": { - "description": "Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`", - "readOnly": true, - "type": "string" - }, - "overlay": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay", - "description": "Required. The proposed changes we are previewing violations for." - }, - "resourceCounts": { - "$ref": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", - "description": "Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "readOnly": true - }, - "state": { - "description": "Output only. The state of the `OrgPolicyViolationsPreview`.", - "enum": [ - "PREVIEW_STATE_UNSPECIFIED", - "PREVIEW_PENDING", - "PREVIEW_RUNNING", - "PREVIEW_SUCCEEDED", - "PREVIEW_FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The OrgPolicyViolationsPreview has not been created yet.", - "The OrgPolicyViolationsPreview is currently being created.", - "The OrgPolicyViolationsPreview creation finished successfully.", - "The OrgPolicyViolationsPreview creation failed with an error." - ], - "readOnly": true, - "type": "string" - }, - "violationsCount": { - "description": "Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts": { - "description": "A summary of the state of all resources scanned for compliance with the changed OrgPolicy.", - "id": "GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts", - "properties": { - "compliant": { - "description": "Output only. Number of scanned resources with zero violations.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "errors": { - "description": "Output only. Number of resources that returned an error when scanned.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "noncompliant": { - "description": "Output only. Number of scanned resources with at least one violation.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "scanned": { - "description": "Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "unenforced": { - "description": "Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaReplay": { - "description": "A resource describing a `Replay`, or simulation.", - "id": "GoogleCloudPolicysimulatorV1betaReplay", - "properties": { - "config": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplayConfig", - "description": "Required. The configuration used for the `Replay`." - }, - "name": { - "description": "Output only. The resource name of the `Replay`, which has the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`", - "readOnly": true, - "type": "string" - }, - "resultsSummary": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplayResultsSummary", - "description": "Output only. Summary statistics about the replayed log entries.", - "readOnly": true - }, - "state": { - "description": "Output only. The current state of the `Replay`.", - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The `Replay` has not started yet.", - "The `Replay` is currently running.", - "The `Replay` has successfully completed.", - "The `Replay` has finished with an error." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaReplayConfig": { - "description": "The configuration used for a Replay.", - "id": "GoogleCloudPolicysimulatorV1betaReplayConfig", - "properties": { - "logSource": { - "description": "The logs to use as input for the Replay.", - "enum": [ - "LOG_SOURCE_UNSPECIFIED", - "RECENT_ACCESSES" - ], - "enumDescriptions": [ - "An unspecified log source. If the log source is unspecified, the Replay defaults to using `RECENT_ACCESSES`.", - "All access logs from the last 90 days. These logs may not include logs from the most recent 7 days." - ], - "type": "string" - }, - "policyOverlay": { - "additionalProperties": { - "$ref": "GoogleIamV1Policy" - }, - "description": "A mapping of the resources that you want to simulate policies for and the policies that you want to simulate. Keys are the full resource names for the resources. For example, `//cloudresourcemanager.googleapis.com/projects/my-project`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. Values are Policy objects representing the policies that you want to simulate. Replays automatically take into account any IAM policies inherited through the resource hierarchy, and any policies set on descendant resources. You do not need to include these policies in the policy overlay.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaReplayDiff": { - "description": "The difference between the results of evaluating an access tuple under the current (baseline) policies and under the proposed (simulated) policies. This difference explains how a principal's access could change if the proposed policies were applied.", - "id": "GoogleCloudPolicysimulatorV1betaReplayDiff", - "properties": { - "accessDiff": { - "$ref": "GoogleCloudPolicysimulatorV1betaAccessStateDiff", - "description": "A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple. The evaluation of the principal's access is reported in the AccessState field." - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaReplayResult": { - "description": "The result of replaying a single access tuple against a simulated state.", - "id": "GoogleCloudPolicysimulatorV1betaReplayResult", - "properties": { - "accessTuple": { - "$ref": "GoogleCloudPolicysimulatorV1betaAccessTuple", - "description": "The access tuple that was replayed. This field includes information about the principal, resource, and permission that were involved in the access attempt." - }, - "diff": { - "$ref": "GoogleCloudPolicysimulatorV1betaReplayDiff", - "description": "The difference between the principal's access under the current (baseline) policies and the principal's access under the proposed (simulated) policies. This field is only included for access tuples that were successfully replayed and had different results under the current policies and the proposed policies." - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "The error that caused the access tuple replay to fail. This field is only included for access tuples that were not replayed successfully." - }, - "lastSeenDate": { - "$ref": "GoogleTypeDate", - "description": "The latest date this access tuple was seen in the logs." - }, - "name": { - "description": "The resource name of the `ReplayResult`, in the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234`", - "type": "string" - }, - "parent": { - "description": "The Replay that the access tuple was included in.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaReplayResultsSummary": { - "description": "Summary statistics about the replayed log entries.", - "id": "GoogleCloudPolicysimulatorV1betaReplayResultsSummary", - "properties": { - "differenceCount": { - "description": "The number of replayed log entries with a difference between baseline and simulated policies.", - "format": "int32", - "type": "integer" - }, - "errorCount": { - "description": "The number of log entries that could not be replayed.", - "format": "int32", - "type": "integer" - }, - "logCount": { - "description": "The total number of log entries replayed.", - "format": "int32", - "type": "integer" - }, - "newestDate": { - "$ref": "GoogleTypeDate", - "description": "The date of the newest log entry replayed." - }, - "oldestDate": { - "$ref": "GoogleTypeDate", - "description": "The date of the oldest log entry replayed." - }, - "unchangedCount": { - "description": "The number of replayed log entries with no difference between baseline and simulated policies.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudPolicysimulatorV1betaResourceContext": { - "description": "ResourceContext provides the context we know about a resource. It is similar in concept to google.cloud.asset.v1.Resource, but focuses on the information specifically used by Simulator.", - "id": "GoogleCloudPolicysimulatorV1betaResourceContext", - "properties": { - "ancestors": { - "description": "The ancestry path of the resource in Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the resource is a project, folder, or organization, the ancestry path starts from the resource itself. Example: `[\"projects/123456789\", \"folders/5432\", \"organizations/1234\"]`", - "items": { - "type": "string" - }, - "type": "array" - }, - "assetType": { - "description": "The asset type of the resource as defined by CAIS. Example: `compute.googleapis.com/Firewall` See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information.", - "type": "string" - }, - "resource": { - "description": "The full name of the resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` See [Resource names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information.", - "type": "string" - } - }, - "type": "object" - }, "GoogleIamV1AuditConfig": { "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": "GoogleIamV1AuditConfig", diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index c2eb3bf5d07..3b3ef1e973e 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1605,7 +1611,7 @@ } } }, - "revision": "20250226", + "revision": "20250326", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { diff --git a/discovery/privateca-v1beta1.json b/discovery/privateca-v1beta1.json index 327ab538cfe..ce83191319c 100644 --- a/discovery/privateca-v1beta1.json +++ b/discovery/privateca-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -580,7 +586,7 @@ } } }, - "revision": "20241204", + "revision": "20250326", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 7372cc70dca..204499fe04c 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -1638,7 +1638,7 @@ } } }, - "revision": "20250218", + "revision": "20250414", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -2215,7 +2215,7 @@ "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) { } ```", + "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: * - (optional) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ```", "type": "string" }, "functionName": { @@ -2373,8 +2373,13 @@ "description": "All supported message transforms types.", "id": "MessageTransform", "properties": { + "disabled": { + "description": "Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.", + "type": "boolean" + }, "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`.", + "deprecated": true, + "description": "Optional. This field is deprecated, use the `disabled` field to disable transforms.", "type": "boolean" }, "javascriptUdf": { diff --git a/discovery/rapidmigrationassessment-v1.json b/discovery/rapidmigrationassessment-v1.json index 14719c42413..6afe19649c7 100644 --- a/discovery/rapidmigrationassessment-v1.json +++ b/discovery/rapidmigrationassessment-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -633,7 +639,7 @@ } } }, - "revision": "20250214", + "revision": "20250324", "rootUrl": "https://rapidmigrationassessment.googleapis.com/", "schemas": { "Annotation": { diff --git a/discovery/recommender-v1beta1.json b/discovery/recommender-v1beta1.json index fb890b3904a..2cfaa6f1782 100644 --- a/discovery/recommender-v1beta1.json +++ b/discovery/recommender-v1beta1.json @@ -118,6 +118,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -589,6 +595,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -959,6 +971,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1430,6 +1448,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1920,7 +1944,7 @@ } } }, - "revision": "20241013", + "revision": "20250323", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudLocationListLocationsResponse": { diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index 688a6ebe342..02b8826eef4 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -189,7 +195,7 @@ ], "parameters": { "name": { - "description": "Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+$", "required": true, @@ -225,7 +231,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "description": "Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -379,7 +385,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -412,7 +418,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -445,7 +451,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -475,7 +481,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -500,7 +506,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/certificateAuthority$", "required": true, @@ -536,7 +542,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -600,7 +606,7 @@ ], "parameters": { "name": { - "description": "Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -1067,7 +1073,7 @@ } } }, - "revision": "20250311", + "revision": "20250418", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -2126,7 +2132,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -2218,6 +2230,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2310,7 +2328,13 @@ "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." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" }, @@ -2721,7 +2745,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -2813,6 +2843,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2905,7 +2941,13 @@ "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." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" } @@ -4163,8 +4205,9 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER", - "PRODUCT_TYPE_FIRESTORE" + "PRODUCT_TYPE_FIRESTORE", + "PRODUCT_TYPE_COMPUTE_ENGINE", + "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ false, @@ -4178,6 +4221,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4191,8 +4235,9 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", - "Firestore product area in GCP." + "Firestore product area in GCP.", + "Compute Engine self managed databases", + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" }, diff --git a/discovery/redis-v1beta1.json b/discovery/redis-v1beta1.json index e1c656852f7..4abcd00740b 100644 --- a/discovery/redis-v1beta1.json +++ b/discovery/redis-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -189,7 +195,7 @@ ], "parameters": { "name": { - "description": "Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+$", "required": true, @@ -225,7 +231,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "description": "Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -379,7 +385,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -412,7 +418,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -445,7 +451,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -475,7 +481,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -500,7 +506,7 @@ ], "parameters": { "name": { - "description": "Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a GCP region.", + "description": "Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/certificateAuthority$", "required": true, @@ -536,7 +542,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -600,7 +606,7 @@ ], "parameters": { "name": { - "description": "Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "description": "Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, @@ -1067,7 +1073,7 @@ } } }, - "revision": "20250311", + "revision": "20250418", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -2126,7 +2132,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -2218,6 +2230,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2310,7 +2328,13 @@ "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." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" }, @@ -2721,7 +2745,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -2813,6 +2843,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2905,7 +2941,13 @@ "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." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" } @@ -4170,8 +4212,9 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER", - "PRODUCT_TYPE_FIRESTORE" + "PRODUCT_TYPE_FIRESTORE", + "PRODUCT_TYPE_COMPUTE_ENGINE", + "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ false, @@ -4185,6 +4228,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4198,8 +4242,9 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", - "Firestore product area in GCP." + "Firestore product area in GCP.", + "Compute Engine self managed databases", + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" }, diff --git a/discovery/reseller-v1.json b/discovery/reseller-v1.json index 04d7a9e81a3..a55bcff5d29 100644 --- a/discovery/reseller-v1.json +++ b/discovery/reseller-v1.json @@ -111,7 +111,7 @@ "customers": { "methods": { "get": { - "description": "Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#get_customer).", + "description": "Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#get_customer).", "flatPath": "apps/reseller/v1/customers/{customerId}", "httpMethod": "GET", "id": "reseller.customers.get", @@ -136,7 +136,7 @@ ] }, "insert": { - "description": "Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](/admin-sdk/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\\` as described in [order a resold account for an existing customer](/admin-sdk/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#tos).", + "description": "Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](https://developers.google.com/workspace/admin/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\\` as described in [order a resold account for an existing customer](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#tos).", "flatPath": "apps/reseller/v1/customers", "httpMethod": "POST", "id": "reseller.customers.insert", @@ -187,7 +187,7 @@ ] }, "update": { - "description": "Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `\"team\"` customer can verify their domain and become `customerType = \"domain\"`. For more information, see [update a customer's settings](/admin-sdk/reseller/v1/how-tos/manage_customers#update_customer).", + "description": "Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `\"team\"` customer can verify their domain and become `customerType = \"domain\"`. For more information, see [update a customer's settings](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#update_customer).", "flatPath": "apps/reseller/v1/customers/{customerId}", "httpMethod": "PUT", "id": "reseller.customers.update", @@ -311,7 +311,7 @@ ] }, "changePlan": { - "description": "Updates a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan).", + "description": "Updates a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan", "httpMethod": "POST", "id": "reseller.subscriptions.changePlan", @@ -345,7 +345,7 @@ ] }, "changeRenewalSettings": { - "description": "Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_renewal).", + "description": "Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_renewal).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings", "httpMethod": "POST", "id": "reseller.subscriptions.changeRenewalSettings", @@ -379,7 +379,7 @@ ] }, "changeSeats": { - "description": "Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see [Manage Subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat).", + "description": "Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see [Manage Subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeSeats", "httpMethod": "POST", "id": "reseller.subscriptions.changeSeats", @@ -458,7 +458,7 @@ ] }, "get": { - "description": "Gets a specific subscription. The `subscriptionId` can be found using the [Retrieve all reseller subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. For more information about retrieving a specific subscription, see the information descrived in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_subscription).", + "description": "Gets a specific subscription. The `subscriptionId` can be found using the [Retrieve all reseller subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. For more information about retrieving a specific subscription, see the information descrived in [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_subscription).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}", "httpMethod": "GET", "id": "reseller.subscriptions.get", @@ -490,7 +490,7 @@ ] }, "insert": { - "description": "Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the [Order a new customer account](/admin-sdk/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#create_subscription).\\ If you did not order the customer's account using the customer insert method, use the customer's `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the [batch operation](/admin-sdk/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to [transfer subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription).", + "description": "Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the [Order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#create_subscription).\\ If you did not order the customer's account using the customer insert method, use the customer's `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the [batch operation](https://developers.google.com/workspace/admin/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to [transfer subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions", "httpMethod": "POST", "id": "reseller.subscriptions.insert", @@ -542,7 +542,7 @@ ] }, "list": { - "description": "Lists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions).", + "description": "Lists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions).", "flatPath": "apps/reseller/v1/subscriptions", "httpMethod": "GET", "id": "reseller.subscriptions.list", @@ -587,7 +587,7 @@ ] }, "startPaidService": { - "description": "Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#paid_service).", + "description": "Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#paid_service).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/startPaidService", "httpMethod": "POST", "id": "reseller.subscriptions.startPaidService", @@ -651,7 +651,7 @@ } } }, - "revision": "20230618", + "revision": "20250419", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { @@ -854,7 +854,7 @@ "type": "string" }, "licensedNumberOfSeats": { - "description": "Read-only field containing the current number of users that are assigned a license for the product defined in `skuId`. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: [`listForProductAndSku`](/admin-sdk/licensing/v1/reference/licenseAssignments/listForProductAndSku).", + "description": "Read-only field containing the current number of users that are assigned a license for the product defined in `skuId`. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: [`listForProductAndSku`](https://developers.google.com/workspace/admin/licensing/v1/reference/licenseAssignments/listForProductAndSku).", "format": "int32", "type": "integer" }, diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index ac8c3edcb1d..8856901841a 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -128,7 +128,7 @@ "type": "string" }, "dataset": { - "description": "Determines which dataset to use for fetching completion. \"user-data\" will use the imported dataset through CompletionService.ImportCompletionData. \"cloud-retail\" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the \"user-data\". Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).", + "description": "Determines which dataset to use for fetching completion. \"user-data\" will use the dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).", "location": "query", "type": "string" }, @@ -138,12 +138,12 @@ "type": "string" }, "enableAttributeSuggestions": { - "description": "If true, attribute suggestions are enabled and provided in the response. This field is only available for the \"cloud-retail\" dataset.", + "description": "If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset.", "location": "query", "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. 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.", + "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. This field will be applied to `completion_results` only. It has no effect on the `attribute_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" }, @@ -2223,7 +2223,7 @@ } } }, - "revision": "20250314", + "revision": "20250417", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2893,7 +2893,7 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2CompleteQueryResponseAttributeResult" }, - "description": "A map of matched attribute suggestions. This field is only available for \"cloud-retail\" dataset. Current supported keys: * `brands` * `categories`", + "description": "A map of matched attribute suggestions. This field is only available for `cloud-retail` dataset. Current supported keys: * `brands` * `categories`", "type": "object" }, "attributionToken": { @@ -2940,7 +2940,7 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2CustomAttribute" }, - "description": "Custom attributes for the suggestion term. * For \"user-data\", the attributes are additional custom attributes ingested through BigQuery. * For \"cloud-retail\", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.", + "description": "Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.", "type": "object" }, "suggestion": { @@ -3778,7 +3778,7 @@ "type": "object" }, "availability": { - "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).", + "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details.", "enum": [ "AVAILABILITY_UNSPECIFIED", "IN_STOCK", @@ -3803,7 +3803,7 @@ "type": "array" }, "placeId": { - "description": "Required. The place ID for the current set of inventory information.", + "description": "Optional. The place ID for the current set of inventory information.", "type": "string" }, "priceInfo": { @@ -5275,7 +5275,7 @@ "id": "GoogleCloudRetailV2SearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Condition boost specifications. If a product 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": "Condition boost specifications. If a product 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": "GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec" }, diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 51084518d98..66063c9e441 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -326,7 +326,7 @@ "type": "string" }, "dataset": { - "description": "Determines which dataset to use for fetching completion. \"user-data\" will use the imported dataset through CompletionService.ImportCompletionData. \"cloud-retail\" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the \"user-data\". Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).", + "description": "Determines which dataset to use for fetching completion. \"user-data\" will use the dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).", "location": "query", "type": "string" }, @@ -336,12 +336,12 @@ "type": "string" }, "enableAttributeSuggestions": { - "description": "If true, attribute suggestions are enabled and provided in the response. This field is only available for the \"cloud-retail\" dataset.", + "description": "If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset.", "location": "query", "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. 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.", + "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. This field will be applied to `completion_results` only. It has no effect on the `attribute_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" }, @@ -2800,7 +2800,7 @@ } } }, - "revision": "20250314", + "revision": "20250417", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4260,7 +4260,7 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult" }, - "description": "A map of matched attribute suggestions. This field is only available for \"cloud-retail\" dataset. Current supported keys: * `brands` * `categories`", + "description": "A map of matched attribute suggestions. This field is only available for `cloud-retail` dataset. Current supported keys: * `brands` * `categories`", "type": "object" }, "attributionToken": { @@ -4307,7 +4307,7 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2alphaCustomAttribute" }, - "description": "Custom attributes for the suggestion term. * For \"user-data\", the attributes are additional custom attributes ingested through BigQuery. * For \"cloud-retail\", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.", + "description": "Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.", "type": "object" }, "facets": { @@ -5578,7 +5578,7 @@ "type": "object" }, "availability": { - "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).", + "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details.", "enum": [ "AVAILABILITY_UNSPECIFIED", "IN_STOCK", @@ -5603,7 +5603,7 @@ "type": "array" }, "placeId": { - "description": "Required. The place ID for the current set of inventory information.", + "description": "Optional. The place ID for the current set of inventory information.", "type": "string" }, "priceInfo": { @@ -7414,7 +7414,7 @@ "id": "GoogleCloudRetailV2alphaSearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Condition boost specifications. If a product 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": "Condition boost specifications. If a product 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": "GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec" }, diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 021e78249d1..4b071ac55d9 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -189,7 +189,7 @@ "type": "string" }, "dataset": { - "description": "Determines which dataset to use for fetching completion. \"user-data\" will use the imported dataset through CompletionService.ImportCompletionData. \"cloud-retail\" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the \"user-data\". Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).", + "description": "Determines which dataset to use for fetching completion. \"user-data\" will use the dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).", "location": "query", "type": "string" }, @@ -199,12 +199,12 @@ "type": "string" }, "enableAttributeSuggestions": { - "description": "If true, attribute suggestions are enabled and provided in the response. This field is only available for the \"cloud-retail\" dataset.", + "description": "If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset.", "location": "query", "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. 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.", + "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. This field will be applied to `completion_results` only. It has no effect on the `attribute_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" }, @@ -2368,7 +2368,7 @@ } } }, - "revision": "20250314", + "revision": "20250417", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4547,7 +4547,7 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult" }, - "description": "A map of matched attribute suggestions. This field is only available for \"cloud-retail\" dataset. Current supported keys: * `brands` * `categories`", + "description": "A map of matched attribute suggestions. This field is only available for `cloud-retail` dataset. Current supported keys: * `brands` * `categories`", "type": "object" }, "attributionToken": { @@ -4594,7 +4594,7 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2betaCustomAttribute" }, - "description": "Custom attributes for the suggestion term. * For \"user-data\", the attributes are additional custom attributes ingested through BigQuery. * For \"cloud-retail\", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.", + "description": "Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.", "type": "object" }, "suggestion": { @@ -5511,7 +5511,7 @@ "type": "object" }, "availability": { - "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).", + "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details.", "enum": [ "AVAILABILITY_UNSPECIFIED", "IN_STOCK", @@ -5536,7 +5536,7 @@ "type": "array" }, "placeId": { - "description": "Required. The place ID for the current set of inventory information.", + "description": "Optional. The place ID for the current set of inventory information.", "type": "string" }, "priceInfo": { @@ -7076,7 +7076,7 @@ "id": "GoogleCloudRetailV2betaSearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Condition boost specifications. If a product 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": "Condition boost specifications. If a product 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": "GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec" }, diff --git a/discovery/run-v1.json b/discovery/run-v1.json index deb808eaccd..d319b2d1954 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -1504,6 +1504,172 @@ ] } } + }, + "workerpools": { + "methods": { + "create": { + "description": "Creates a new WorkerPool. WorkerPool creation will trigger a new deployment. Use GetWorkerPool, and check worker_pool.status to determine if the WorkerPool is ready.", + "flatPath": "apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools", + "httpMethod": "POST", + "id": "run.namespaces.workerpools.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "dryRun": { + "description": "Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource's parent. In Cloud Run, it may be one of the following: * `{project_id_or_number}` * `namespaces/{project_id_or_number}` * `namespaces/{project_id_or_number}/workerpools` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", + "location": "path", + "pattern": "^namespaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "apis/run.googleapis.com/v1/{+parent}/workerpools", + "request": { + "$ref": "WorkerPool" + }, + "response": { + "$ref": "WorkerPool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the provided worker pool. This will cause the WorkerPool to stop all instances and will delete all associated WorkerPoolRevisions.", + "flatPath": "apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools/{workerpoolsId}", + "httpMethod": "DELETE", + "id": "run.namespaces.workerpools.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "dryRun": { + "description": "Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the worker pool to delete. It can be any of the following forms: * `namespaces/{project_id_or_number}/workerpools/{worker_pool_name}` (only when the `endpoint` is regional) * `projects/{project_id_or_number}/locations/{region}/workerpools/{worker_pool_name}` * `projects/{project_id_or_number}/regions/{region}/workerpools/{worker_pool_name}`", + "location": "path", + "pattern": "^namespaces/[^/]+/workerpools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "apis/run.googleapis.com/v1/{+name}", + "response": { + "$ref": "Status" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a worker pool.", + "flatPath": "apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools/{workerpoolsId}", + "httpMethod": "GET", + "id": "run.namespaces.workerpools.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the worker pool to retrieve. It can be any of the following forms: * `namespaces/{project_id_or_number}/workerpools/{worker_pool_name}` (only when the `endpoint` is regional) * `projects/{project_id_or_number}/locations/{region}/workerpools/{worker_pool_name}` * `projects/{project_id_or_number}/regions/{region}/workerpools/{worker_pool_name}`", + "location": "path", + "pattern": "^namespaces/[^/]+/workerpools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "apis/run.googleapis.com/v1/{+name}", + "response": { + "$ref": "WorkerPool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists worker pools for the given project and region. Results are sorted by creation time, descending.", + "flatPath": "apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools", + "httpMethod": "GET", + "id": "run.namespaces.workerpools.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "continue": { + "description": "Encoded string to continue paging.", + "location": "query", + "type": "string" + }, + "labelSelector": { + "description": "=, !=, exists, in, and notIn.", + "location": "query", + "type": "string" + }, + "limit": { + "description": "The maximum number of records that should be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "parent": { + "description": "Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * `{project_id_or_number}` * `namespaces/{project_id_or_number}` * `namespaces/{project_id_or_number}/workerpools` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", + "location": "path", + "pattern": "^namespaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "apis/run.googleapis.com/v1/{+parent}/workerpools", + "response": { + "$ref": "ListWorkerPoolsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "replaceWorkerPool": { + "description": "Replaces a worker pool. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", + "flatPath": "apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools/{workerpoolsId}", + "httpMethod": "PUT", + "id": "run.namespaces.workerpools.replaceWorkerPool", + "parameterOrder": [ + "name" + ], + "parameters": { + "dryRun": { + "description": "Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the worker pool to replace. It can be any of the following forms: * `namespaces/{project_id_or_number}/workerpools/{worker_pool_name}` (only when the `endpoint` is regional) * `projects/{project_id_or_number}/locations/{region}/workerpools/{worker_pool_name}` * `projects/{project_id_or_number}/regions/{region}/workerpools/{worker_pool_name}`", + "location": "path", + "pattern": "^namespaces/[^/]+/workerpools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "apis/run.googleapis.com/v1/{+name}", + "request": { + "$ref": "WorkerPool" + }, + "response": { + "$ref": "WorkerPool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -1560,6 +1726,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2624,7 +2796,7 @@ } } }, - "revision": "20250309", + "revision": "20250425", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4425,7 +4597,7 @@ "type": "string" }, "path": { - "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "description": "Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", "type": "string" }, "repository": { @@ -5049,6 +5221,26 @@ }, "type": "object" }, + "InstanceSplit": { + "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": "InstanceSplit", + "properties": { + "latestRevision": { + "description": "Uses the \"status.latestReadyRevisionName\" to determine the traffic target. When it changes, traffic will automatically migrate from the prior \"latest ready\" revision to the new one.", + "type": "boolean" + }, + "percent": { + "description": "Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.", + "format": "int32", + "type": "integer" + }, + "revisionName": { + "description": "Revision to which to assign this portion of instances.", + "type": "string" + } + }, + "type": "object" + }, "Job": { "description": "Job represents the configuration of a single job, which references a container image which is run to completion.", "id": "Job", @@ -5463,6 +5655,39 @@ }, "type": "object" }, + "ListWorkerPoolsResponse": { + "description": "A list of WorkerPool resources.", + "id": "ListWorkerPoolsResponse", + "properties": { + "apiVersion": { + "description": "The API version for this call; returns \"run.googleapis.com/v1\".", + "type": "string" + }, + "items": { + "description": "List of WorkerPools.", + "items": { + "$ref": "WorkerPool" + }, + "type": "array" + }, + "kind": { + "description": "The kind of this resource; returns \"WorkerPoolList\".", + "type": "string" + }, + "metadata": { + "$ref": "ListMeta", + "description": "Metadata associated with this WorkerPool list." + }, + "unreachable": { + "description": "For calls against the global endpoint, returns the list of Cloud locations that could not be reached. For regional calls, this field is not used.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "LocalObjectReference": { "description": "Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", "id": "LocalObjectReference", @@ -5535,7 +5760,7 @@ "additionalProperties": { "type": "string" }, - "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", + "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", "type": "object" }, "clusterName": { @@ -5866,7 +6091,7 @@ "type": "string" }, "timeoutSeconds": { - "description": "TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).", + "description": "Optional. TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).", "format": "int32", "type": "integer" }, @@ -6563,6 +6788,85 @@ } }, "type": "object" + }, + "WorkerPool": { + "description": "WorkerPool acts as a top-level container that manages a set instance splits among a set of Revisions and a template for creating new Revisions.", + "id": "WorkerPool", + "properties": { + "apiVersion": { + "description": "The API version for this call. It must be \"run.googleapis.com/v1\".", + "type": "string" + }, + "kind": { + "description": "The kind of resource. It must be \"WorkerPool\".", + "type": "string" + }, + "metadata": { + "$ref": "ObjectMeta", + "description": "Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description`" + }, + "spec": { + "$ref": "WorkerPoolSpec", + "description": "Holds the desired state of the WorkerPool (from the client)." + }, + "status": { + "$ref": "WorkerPoolStatus", + "description": "Communicates the system-controlled state of the WorkerPool." + } + }, + "type": "object" + }, + "WorkerPoolSpec": { + "description": "WorkerPoolSpec holds the desired state of the WorkerPool's template and instance splits.", + "id": "WorkerPoolSpec", + "properties": { + "instanceSplits": { + "description": "Specifies how to distribute instances over a collection of Revisions.", + "items": { + "$ref": "InstanceSplit" + }, + "type": "array" + }, + "template": { + "$ref": "RevisionTemplate", + "description": "Holds the latest specification for the Revision to be stamped out." + } + }, + "type": "object" + }, + "WorkerPoolStatus": { + "description": "The current state of the WorkerPool. Output only.", + "id": "WorkerPoolStatus", + "properties": { + "conditions": { + "description": "Conditions communicate information about ongoing/complete reconciliation processes that bring the `spec` inline with the observed state of the world. * `Ready`: `True` when all underlying resources are ready.", + "items": { + "$ref": "GoogleCloudRunV1Condition" + }, + "type": "array" + }, + "instanceSplits": { + "description": "Holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed.", + "items": { + "$ref": "InstanceSplit" + }, + "type": "array" + }, + "latestCreatedRevisionName": { + "description": "Name of the last revision that was created from this WorkerPool's template. It might not be ready yet, for that use LatestReadyRevisionName.", + "type": "string" + }, + "latestReadyRevisionName": { + "description": "Name of the latest Revision from this WorkerPool's template that has had its `Ready` condition become `True`.", + "type": "string" + }, + "observedGeneration": { + "description": "Returns the generation last seen by the system. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 5471aaadc75..5e6b80f8e07 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1863,7 +1863,7 @@ } } }, - "revision": "20250309", + "revision": "20250425", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2068,7 +2068,8 @@ "WAITING_FOR_OPERATION", "IMMEDIATE_RETRY", "POSTPONED_RETRY", - "INTERNAL" + "INTERNAL", + "VPC_NETWORK_NOT_FOUND" ], "enumDescriptions": [ "Default value.", @@ -2085,7 +2086,8 @@ "Waiting for operation to complete.", "System will retry immediately.", "System will retry later; current attempt failed.", - "An internal error occurred. Further information may be in the message." + "An internal error occurred. Further information may be in the message.", + "User-provided VPC network was not found." ], "readOnly": true, "type": "string" @@ -3365,6 +3367,11 @@ "readOnly": true, "type": "string" }, + "gpuZonalRedundancyDisabled": { + "description": "Optional. Output only. True if GPU zonal redundancy is disabled on this revision.", + "readOnly": true, + "type": "boolean" + }, "labels": { "additionalProperties": { "type": "string" @@ -3572,6 +3579,10 @@ ], "type": "string" }, + "gpuZonalRedundancyDisabled": { + "description": "Optional. True if GPU zonal redundancy is disabled on this revision.", + "type": "boolean" + }, "healthCheckDisabled": { "description": "Optional. Disables health checking containers during deployment.", "type": "boolean" @@ -3772,6 +3783,10 @@ "readOnly": true, "type": "string" }, + "iapEnabled": { + "description": "Optional. IAP settings on the Service.", + "type": "boolean" + }, "ingress": { "description": "Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.", "enum": [ @@ -3791,7 +3806,7 @@ "type": "string" }, "invokerIamDisabled": { - "description": "Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.", + "description": "Optional. Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.", "type": "boolean" }, "labels": { @@ -3873,6 +3888,11 @@ "description": "Output only. The Condition of this Service, 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 }, + "threatDetectionEnabled": { + "description": "Output only. True if Cloud Run Threat Detection monitoring is enabled for the parent project of this Service.", + "readOnly": true, + "type": "boolean" + }, "traffic": { "description": "Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision.", "items": { @@ -4137,6 +4157,11 @@ "readOnly": true, "type": "string" }, + "gpuZonalRedundancyDisabled": { + "description": "Optional. Output only. True if GPU zonal redundancy is disabled on this task.", + "readOnly": true, + "type": "boolean" + }, "index": { "description": "Output only. Index of the Task, unique per execution, and beginning at 0.", "format": "int32", @@ -4779,16 +4804,6 @@ "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", @@ -5790,7 +5805,7 @@ "type": "string" }, "path": { - "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "description": "Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", "type": "string" }, "repository": { @@ -6543,7 +6558,8 @@ "type": "object" }, "Proto2BridgeMessageSet": { - "description": "This is proto2's version of MessageSet.", + "deprecated": true, + "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", "id": "Proto2BridgeMessageSet", "properties": {}, "type": "object" diff --git a/discovery/script-v1.json b/discovery/script-v1.json index f6d4bb1ea66..aa3cde13c76 100644 --- a/discovery/script-v1.json +++ b/discovery/script-v1.json @@ -891,7 +891,7 @@ } } }, - "revision": "20250130", + "revision": "20250406", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { @@ -1614,7 +1614,7 @@ "description": "User who last modified the script." }, "parentId": { - "description": "The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This filed is optional, and if not set, a stand-alone script will be created.", + "description": "The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This field is optional, and if not set, a stand-alone script will be created.", "type": "string" }, "scriptId": { diff --git a/discovery/searchads360-v0.json b/discovery/searchads360-v0.json index ae3328c6d7e..954714fefcd 100644 --- a/discovery/searchads360-v0.json +++ b/discovery/searchads360-v0.json @@ -260,7 +260,7 @@ } } }, - "revision": "20241108", + "revision": "20250407", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -5413,7 +5413,7 @@ "type": "object" }, "GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView": { - "description": "A view on the usage of ad group ad asset combination.", + "description": "A view on the usage of asset group asset top combinations.", "id": "GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView", "properties": { "assetGroupTopCombinations": { @@ -6955,6 +6955,50 @@ "GOOGLE_ANALYTICS_4_CUSTOM", "GOOGLE_ANALYTICS_4_PURCHASE" ], + "enumDeprecated": [ + 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, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Not specified.", "Used for return value only. Represents value unknown in this version.", @@ -6986,7 +7030,7 @@ "Floodlight activity that tracks the number of sales made or the number of items purchased. Can also capture the total value of each sale. Read only.", "Conversions that track local actions from Google's products and services after interacting with an ad. Read only.", "Conversions reported when a user submits a lead form. Read only.", - "Conversions that come from Salesforce. Read only.", + "Deprecated: The Salesforce integration will be going away and replaced with an improved way to import your conversions from Salesforce. - see https://support.google.com/google-ads/answer/14728349", "Conversions imported from Search Ads 360 Floodlight data. Read only.", "Call conversions that occur on Smart campaign Ads without call tracking setup, using Smart campaign custom criteria. Read only.", "The user clicks on a call element within Google Maps. Smart campaign only. Read only.", @@ -7271,6 +7315,35 @@ "description": "A customer.", "id": "GoogleAdsSearchads360V0Resources__Customer", "properties": { + "accountLevel": { + "description": "Output only. The account level of the customer: Manager, Sub-manager, Associate manager, Service account.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "CLIENT_ACCOUNT_FACEBOOK", + "CLIENT_ACCOUNT_GOOGLE_ADS", + "CLIENT_ACCOUNT_MICROSOFT", + "CLIENT_ACCOUNT_YAHOO_JAPAN", + "CLIENT_ACCOUNT_ENGINE_TRACK", + "MANAGER", + "SUB_MANAGER", + "ASSOCIATE_MANAGER" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Client account (Facebook)", + "Client account (Google Ads)", + "Client account (Microsoft)", + "Client account (Yahoo Japan)", + "Client account (Engine Track)", + "Top-level manager.", + "Sub manager.", + "Associate manager." + ], + "readOnly": true, + "type": "string" + }, "accountStatus": { "description": "Output only. Account status, for example, Enabled, Paused, Removed, etc.", "enum": [ @@ -7323,6 +7396,17 @@ "readOnly": true, "type": "string" }, + "associateManagerDescriptiveName": { + "description": "Output only. The descriptive name of the associate manager.", + "readOnly": true, + "type": "string" + }, + "associateManagerId": { + "description": "Output only. The customer ID of the associate manager. A 0 value indicates that the customer has no SA360 associate manager.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "autoTaggingEnabled": { "description": "Whether auto-tagging is enabled for the customer.", "type": "boolean" @@ -7375,6 +7459,17 @@ "readOnly": true, "type": "boolean" }, + "managerDescriptiveName": { + "description": "Output only. The descriptive name of the manager.", + "readOnly": true, + "type": "string" + }, + "managerId": { + "description": "Output only. The customer ID of the manager. A 0 value indicates that the customer has no SA360 manager.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "resourceName": { "description": "Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`", "type": "string" @@ -7400,6 +7495,17 @@ "readOnly": true, "type": "string" }, + "subManagerDescriptiveName": { + "description": "Output only. The descriptive name of the sub manager.", + "readOnly": true, + "type": "string" + }, + "subManagerId": { + "description": "Output only. The customer ID of the sub manager. A 0 value indicates that the customer has no sub SA360 manager.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "timeZone": { "description": "Immutable. The local timezone ID of the customer.", "type": "string" diff --git a/discovery/searchconsole-v1.json b/discovery/searchconsole-v1.json index 616c9841f34..9bb02fab63a 100644 --- a/discovery/searchconsole-v1.json +++ b/discovery/searchconsole-v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20250122", + "revision": "20250409", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { @@ -1130,12 +1130,14 @@ "enum": [ "DATA_STATE_UNSPECIFIED", "FINAL", - "ALL" + "ALL", + "HOURLY_ALL" ], "enumDescriptions": [ "Default value, should not be used.", "Include full final data only, without partial.", - "Include all data, full and partial." + "Include all data, full and partial.", + "Include hourly data, full and partial. Required when grouping by HOUR." ], "type": "string" }, @@ -1155,15 +1157,17 @@ "PAGE", "COUNTRY", "DEVICE", - "SEARCH_APPEARANCE" + "SEARCH_APPEARANCE", + "HOUR" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "Group by date, which is returned in YYYY-MM-DD format, in PT time (UTC - 7:00/8:00).", + "Group by query string.", + "Group by page, a URI string.", + "Group by country, specified by 3-letter country code ([ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).", + "Group by device type (DESKTOP, MOBILE and TABLET).", + "Group by search result feature.", + "Group by hour, which is returned in YYYY-MM-DDThh:mm:ss[+|-]hh:mm format (ISO-8601 extended offset date-time format) in PT time (UTC - 7:00/8:00). Data is available up to 10 days. Requires setting the dataState to HOURLY_ALL." ], "type": "string" }, diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index 3aa1c552cd9..4006115c900 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -146,6 +146,16 @@ "endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us.rep.googleapis.com/", @@ -285,6 +295,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1250,7 +1266,7 @@ } } }, - "revision": "20250228", + "revision": "20250324", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta1.json b/discovery/secretmanager-v1beta1.json index 09872e5c212..270f0bd2bff 100644 --- a/discovery/secretmanager-v1beta1.json +++ b/discovery/secretmanager-v1beta1.json @@ -146,6 +146,16 @@ "endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us.rep.googleapis.com/", @@ -285,6 +295,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -770,7 +786,7 @@ } } }, - "revision": "20250228", + "revision": "20250324", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta2.json b/discovery/secretmanager-v1beta2.json index eb861ed7a46..3c7d43c9544 100644 --- a/discovery/secretmanager-v1beta2.json +++ b/discovery/secretmanager-v1beta2.json @@ -146,6 +146,16 @@ "endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us.rep.googleapis.com/", @@ -285,6 +295,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1250,7 +1266,7 @@ } } }, - "revision": "20250228", + "revision": "20250324", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index dbc747c36a4..d47c2f3fc9e 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -5938,7 +5938,7 @@ } } }, - "revision": "20250308", + "revision": "20250411", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6042,6 +6042,18 @@ }, "type": "object" }, + "AffectedResources": { + "description": "Details about resources affected by this finding.", + "id": "AffectedResources", + "properties": { + "count": { + "description": "The count of resources affected by the finding.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Allowed": { "description": "Allowed IP rule.", "id": "Allowed", @@ -6688,6 +6700,20 @@ }, "type": "object" }, + "Chokepoint": { + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", + "id": "Chokepoint", + "properties": { + "relatedFindings": { + "description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -6815,60 +6841,6 @@ }, "type": "object" }, - "ComplianceSnapshot": { - "deprecated": true, - "description": "Result containing the properties and count of a ComplianceSnapshot request.", - "id": "ComplianceSnapshot", - "properties": { - "category": { - "description": "The category of Findings matching.", - "type": "string" - }, - "cloudProvider": { - "description": "The cloud provider for the compliance snapshot.", - "enum": [ - "CLOUD_PROVIDER_UNSPECIFIED", - "GOOGLE_CLOUD_PLATFORM", - "AMAZON_WEB_SERVICES", - "MICROSOFT_AZURE" - ], - "enumDescriptions": [ - "The cloud provider is unspecified.", - "The cloud provider is Google Cloud Platform.", - "The cloud provider is Amazon Web Services.", - "The cloud provider is Microsoft Azure." - ], - "type": "string" - }, - "complianceStandard": { - "description": "The compliance standard (ie CIS).", - "type": "string" - }, - "complianceVersion": { - "description": "The compliance version (ie 1.3) in CIS 1.3.", - "type": "string" - }, - "count": { - "description": "Total count of findings for the given properties.", - "format": "int64", - "type": "string" - }, - "leafContainerResource": { - "description": "The leaf container resource name that is closest to the snapshot.", - "type": "string" - }, - "name": { - "description": "The compliance snapshot name. Format: //sources//complianceSnapshots/", - "type": "string" - }, - "snapshotTime": { - "description": "The snapshot time of the snapshot.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, "Connection": { "description": "Contains information about the IP connection associated with the finding.", "id": "Connection", @@ -7752,6 +7724,10 @@ "$ref": "Access", "description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." }, + "affectedResources": { + "$ref": "AffectedResources", + "description": "AffectedResources associated with the finding." + }, "application": { "$ref": "Application", "description": "Represents an application associated with the finding." @@ -7772,6 +7748,10 @@ "description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, + "chokepoint": { + "$ref": "Chokepoint", + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." + }, "cloudArmor": { "$ref": "CloudArmor", "description": "Fields related to Cloud Armor findings." @@ -7890,7 +7870,8 @@ "SCC_ERROR", "POSTURE_VIOLATION", "TOXIC_COMBINATION", - "SENSITIVE_DATA_RISK" + "SENSITIVE_DATA_RISK", + "CHOKEPOINT" ], "enumDescriptions": [ "Unspecified finding class.", @@ -7901,7 +7882,8 @@ "Describes an error that prevents some SCC functionality.", "Describes a potential security risk due to a change in the security posture.", "Describes a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", - "Describes a potential security risk to data assets that contain sensitive data." + "Describes a potential security risk to data assets that contain sensitive data.", + "Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." ], "type": "string" }, @@ -9181,6 +9163,18 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2AffectedResources": { + "description": "Details about resources affected by this finding.", + "id": "GoogleCloudSecuritycenterV2AffectedResources", + "properties": { + "count": { + "description": "The count of resources affected by the finding.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Allowed": { "description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", @@ -9577,6 +9571,20 @@ "properties": {}, "type": "object" }, + "GoogleCloudSecuritycenterV2Chokepoint": { + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", + "id": "GoogleCloudSecuritycenterV2Chokepoint", + "properties": { + "relatedFindings": { + "description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "GoogleCloudSecuritycenterV2CloudArmor", @@ -10419,6 +10427,10 @@ "$ref": "GoogleCloudSecuritycenterV2Access", "description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." }, + "affectedResources": { + "$ref": "GoogleCloudSecuritycenterV2AffectedResources", + "description": "AffectedResources associated with the finding." + }, "application": { "$ref": "GoogleCloudSecuritycenterV2Application", "description": "Represents an application associated with the finding." @@ -10440,6 +10452,10 @@ "description": "Immutable. The additional taxonomy group within findings from a given source. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, + "chokepoint": { + "$ref": "GoogleCloudSecuritycenterV2Chokepoint", + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." + }, "cloudArmor": { "$ref": "GoogleCloudSecuritycenterV2CloudArmor", "description": "Fields related to Cloud Armor findings." @@ -10559,7 +10575,8 @@ "SCC_ERROR", "POSTURE_VIOLATION", "TOXIC_COMBINATION", - "SENSITIVE_DATA_RISK" + "SENSITIVE_DATA_RISK", + "CHOKEPOINT" ], "enumDescriptions": [ "Unspecified finding class.", @@ -10570,7 +10587,8 @@ "Describes an error that prevents some SCC functionality.", "Describes a potential security risk due to a change in the security posture.", "Describes a combination of security issues that represent a more severe security problem when taken together.", - "Describes a potential security risk to data assets that contain sensitive data." + "Describes a potential security risk to data assets that contain sensitive data.", + "Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." ], "type": "string" }, @@ -10805,11 +10823,13 @@ "description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", - "GROUP_TYPE_TOXIC_COMBINATION" + "GROUP_TYPE_TOXIC_COMBINATION", + "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ "Default value.", - "Group represents a toxic combination." + "Group represents a toxic combination.", + "Group represents a chokepoint." ], "type": "string" } @@ -11588,12 +11608,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -11617,31 +11645,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -11652,6 +11693,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -11660,12 +11702,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -11689,31 +11739,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -11724,6 +11787,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -11777,12 +11841,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -11806,31 +11878,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -11841,6 +11926,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -11849,12 +11935,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -11878,31 +11972,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -11913,6 +12020,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -13039,11 +13147,13 @@ "description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", - "GROUP_TYPE_TOXIC_COMBINATION" + "GROUP_TYPE_TOXIC_COMBINATION", + "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ "Default value.", - "Group represents a toxic combination." + "Group represents a toxic combination.", + "Group represents a chokepoint." ], "type": "string" } @@ -13829,12 +13939,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -13858,31 +13976,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -13893,6 +14024,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -13901,12 +14033,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -13930,31 +14070,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -13965,6 +14118,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -14018,12 +14172,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -14047,31 +14209,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -14082,6 +14257,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -14090,12 +14266,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -14119,31 +14303,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -14154,6 +14351,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index b3a582b0653..5ea5cd9301a 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -913,7 +913,7 @@ } } }, - "revision": "20250308", + "revision": "20250411", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1017,6 +1017,18 @@ }, "type": "object" }, + "AffectedResources": { + "description": "Details about resources affected by this finding.", + "id": "AffectedResources", + "properties": { + "count": { + "description": "The count of resources affected by the finding.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Allowed": { "description": "Allowed IP rule.", "id": "Allowed", @@ -1475,6 +1487,20 @@ "properties": {}, "type": "object" }, + "Chokepoint": { + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", + "id": "Chokepoint", + "properties": { + "relatedFindings": { + "description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -1602,60 +1628,6 @@ }, "type": "object" }, - "ComplianceSnapshot": { - "deprecated": true, - "description": "Result containing the properties and count of a ComplianceSnapshot request.", - "id": "ComplianceSnapshot", - "properties": { - "category": { - "description": "The category of Findings matching.", - "type": "string" - }, - "cloudProvider": { - "description": "The cloud provider for the compliance snapshot.", - "enum": [ - "CLOUD_PROVIDER_UNSPECIFIED", - "GOOGLE_CLOUD_PLATFORM", - "AMAZON_WEB_SERVICES", - "MICROSOFT_AZURE" - ], - "enumDescriptions": [ - "The cloud provider is unspecified.", - "The cloud provider is Google Cloud Platform.", - "The cloud provider is Amazon Web Services.", - "The cloud provider is Microsoft Azure." - ], - "type": "string" - }, - "complianceStandard": { - "description": "The compliance standard (ie CIS).", - "type": "string" - }, - "complianceVersion": { - "description": "The compliance version (ie 1.3) in CIS 1.3.", - "type": "string" - }, - "count": { - "description": "Total count of findings for the given properties.", - "format": "int64", - "type": "string" - }, - "leafContainerResource": { - "description": "The leaf container resource name that is closest to the snapshot.", - "type": "string" - }, - "name": { - "description": "The compliance snapshot name. Format: //sources//complianceSnapshots/", - "type": "string" - }, - "snapshotTime": { - "description": "The snapshot time of the snapshot.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, "Connection": { "description": "Contains information about the IP connection associated with the finding.", "id": "Connection", @@ -2342,6 +2314,10 @@ "$ref": "Access", "description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." }, + "affectedResources": { + "$ref": "AffectedResources", + "description": "AffectedResources associated with the finding." + }, "application": { "$ref": "Application", "description": "Represents an application associated with the finding." @@ -2362,6 +2338,10 @@ "description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, + "chokepoint": { + "$ref": "Chokepoint", + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." + }, "cloudArmor": { "$ref": "CloudArmor", "description": "Fields related to Cloud Armor findings." @@ -2480,7 +2460,8 @@ "SCC_ERROR", "POSTURE_VIOLATION", "TOXIC_COMBINATION", - "SENSITIVE_DATA_RISK" + "SENSITIVE_DATA_RISK", + "CHOKEPOINT" ], "enumDescriptions": [ "Unspecified finding class.", @@ -2491,7 +2472,8 @@ "Describes an error that prevents some SCC functionality.", "Describes a potential security risk due to a change in the security posture.", "Describes a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", - "Describes a potential security risk to data assets that contain sensitive data." + "Describes a potential security risk to data assets that contain sensitive data.", + "Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." ], "type": "string" }, @@ -3852,6 +3834,18 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2AffectedResources": { + "description": "Details about resources affected by this finding.", + "id": "GoogleCloudSecuritycenterV2AffectedResources", + "properties": { + "count": { + "description": "The count of resources affected by the finding.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Allowed": { "description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", @@ -4248,6 +4242,20 @@ "properties": {}, "type": "object" }, + "GoogleCloudSecuritycenterV2Chokepoint": { + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", + "id": "GoogleCloudSecuritycenterV2Chokepoint", + "properties": { + "relatedFindings": { + "description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "GoogleCloudSecuritycenterV2CloudArmor", @@ -5090,6 +5098,10 @@ "$ref": "GoogleCloudSecuritycenterV2Access", "description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." }, + "affectedResources": { + "$ref": "GoogleCloudSecuritycenterV2AffectedResources", + "description": "AffectedResources associated with the finding." + }, "application": { "$ref": "GoogleCloudSecuritycenterV2Application", "description": "Represents an application associated with the finding." @@ -5111,6 +5123,10 @@ "description": "Immutable. The additional taxonomy group within findings from a given source. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, + "chokepoint": { + "$ref": "GoogleCloudSecuritycenterV2Chokepoint", + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." + }, "cloudArmor": { "$ref": "GoogleCloudSecuritycenterV2CloudArmor", "description": "Fields related to Cloud Armor findings." @@ -5230,7 +5246,8 @@ "SCC_ERROR", "POSTURE_VIOLATION", "TOXIC_COMBINATION", - "SENSITIVE_DATA_RISK" + "SENSITIVE_DATA_RISK", + "CHOKEPOINT" ], "enumDescriptions": [ "Unspecified finding class.", @@ -5241,7 +5258,8 @@ "Describes an error that prevents some SCC functionality.", "Describes a potential security risk due to a change in the security posture.", "Describes a combination of security issues that represent a more severe security problem when taken together.", - "Describes a potential security risk to data assets that contain sensitive data." + "Describes a potential security risk to data assets that contain sensitive data.", + "Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." ], "type": "string" }, @@ -5476,11 +5494,13 @@ "description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", - "GROUP_TYPE_TOXIC_COMBINATION" + "GROUP_TYPE_TOXIC_COMBINATION", + "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ "Default value.", - "Group represents a toxic combination." + "Group represents a toxic combination.", + "Group represents a chokepoint." ], "type": "string" } @@ -6259,12 +6279,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -6288,31 +6316,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -6323,6 +6364,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -6331,12 +6373,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -6360,31 +6410,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -6395,6 +6458,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -6448,12 +6512,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -6477,31 +6549,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -6512,6 +6597,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -6520,12 +6606,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -6549,31 +6643,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -6584,6 +6691,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -7693,11 +7801,13 @@ "description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", - "GROUP_TYPE_TOXIC_COMBINATION" + "GROUP_TYPE_TOXIC_COMBINATION", + "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ "Default value.", - "Group represents a toxic combination." + "Group represents a toxic combination.", + "Group represents a chokepoint." ], "type": "string" } @@ -8219,12 +8329,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -8248,31 +8366,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -8283,6 +8414,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -8291,12 +8423,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -8320,31 +8460,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -8355,6 +8508,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -8408,12 +8562,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -8437,31 +8599,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -8472,6 +8647,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -8480,12 +8656,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -8509,31 +8693,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -8544,6 +8741,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index 2503342b09e..1919acb3e38 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -2003,7 +2003,7 @@ } } }, - "revision": "20250308", + "revision": "20250411", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2107,6 +2107,18 @@ }, "type": "object" }, + "AffectedResources": { + "description": "Details about resources affected by this finding.", + "id": "AffectedResources", + "properties": { + "count": { + "description": "The count of resources affected by the finding.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Allowed": { "description": "Allowed IP rule.", "id": "Allowed", @@ -2425,6 +2437,20 @@ }, "type": "object" }, + "Chokepoint": { + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", + "id": "Chokepoint", + "properties": { + "relatedFindings": { + "description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -2552,60 +2578,6 @@ }, "type": "object" }, - "ComplianceSnapshot": { - "deprecated": true, - "description": "Result containing the properties and count of a ComplianceSnapshot request.", - "id": "ComplianceSnapshot", - "properties": { - "category": { - "description": "The category of Findings matching.", - "type": "string" - }, - "cloudProvider": { - "description": "The cloud provider for the compliance snapshot.", - "enum": [ - "CLOUD_PROVIDER_UNSPECIFIED", - "GOOGLE_CLOUD_PLATFORM", - "AMAZON_WEB_SERVICES", - "MICROSOFT_AZURE" - ], - "enumDescriptions": [ - "The cloud provider is unspecified.", - "The cloud provider is Google Cloud Platform.", - "The cloud provider is Amazon Web Services.", - "The cloud provider is Microsoft Azure." - ], - "type": "string" - }, - "complianceStandard": { - "description": "The compliance standard (ie CIS).", - "type": "string" - }, - "complianceVersion": { - "description": "The compliance version (ie 1.3) in CIS 1.3.", - "type": "string" - }, - "count": { - "description": "Total count of findings for the given properties.", - "format": "int64", - "type": "string" - }, - "leafContainerResource": { - "description": "The leaf container resource name that is closest to the snapshot.", - "type": "string" - }, - "name": { - "description": "The compliance snapshot name. Format: //sources//complianceSnapshots/", - "type": "string" - }, - "snapshotTime": { - "description": "The snapshot time of the snapshot.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, "Config": { "description": "Configuration of a module.", "id": "Config", @@ -3439,6 +3411,10 @@ "$ref": "Access", "description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." }, + "affectedResources": { + "$ref": "AffectedResources", + "description": "AffectedResources associated with the finding." + }, "application": { "$ref": "Application", "description": "Represents an application associated with the finding." @@ -3459,6 +3435,10 @@ "description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, + "chokepoint": { + "$ref": "Chokepoint", + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." + }, "cloudArmor": { "$ref": "CloudArmor", "description": "Fields related to Cloud Armor findings." @@ -3577,7 +3557,8 @@ "SCC_ERROR", "POSTURE_VIOLATION", "TOXIC_COMBINATION", - "SENSITIVE_DATA_RISK" + "SENSITIVE_DATA_RISK", + "CHOKEPOINT" ], "enumDescriptions": [ "Unspecified finding class.", @@ -3588,7 +3569,8 @@ "Describes an error that prevents some SCC functionality.", "Describes a potential security risk due to a change in the security posture.", "Describes a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", - "Describes a potential security risk to data assets that contain sensitive data." + "Describes a potential security risk to data assets that contain sensitive data.", + "Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." ], "type": "string" }, @@ -4845,6 +4827,18 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2AffectedResources": { + "description": "Details about resources affected by this finding.", + "id": "GoogleCloudSecuritycenterV2AffectedResources", + "properties": { + "count": { + "description": "The count of resources affected by the finding.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Allowed": { "description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", @@ -5241,6 +5235,20 @@ "properties": {}, "type": "object" }, + "GoogleCloudSecuritycenterV2Chokepoint": { + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", + "id": "GoogleCloudSecuritycenterV2Chokepoint", + "properties": { + "relatedFindings": { + "description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "GoogleCloudSecuritycenterV2CloudArmor", @@ -6083,6 +6091,10 @@ "$ref": "GoogleCloudSecuritycenterV2Access", "description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." }, + "affectedResources": { + "$ref": "GoogleCloudSecuritycenterV2AffectedResources", + "description": "AffectedResources associated with the finding." + }, "application": { "$ref": "GoogleCloudSecuritycenterV2Application", "description": "Represents an application associated with the finding." @@ -6104,6 +6116,10 @@ "description": "Immutable. The additional taxonomy group within findings from a given source. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, + "chokepoint": { + "$ref": "GoogleCloudSecuritycenterV2Chokepoint", + "description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." + }, "cloudArmor": { "$ref": "GoogleCloudSecuritycenterV2CloudArmor", "description": "Fields related to Cloud Armor findings." @@ -6223,7 +6239,8 @@ "SCC_ERROR", "POSTURE_VIOLATION", "TOXIC_COMBINATION", - "SENSITIVE_DATA_RISK" + "SENSITIVE_DATA_RISK", + "CHOKEPOINT" ], "enumDescriptions": [ "Unspecified finding class.", @@ -6234,7 +6251,8 @@ "Describes an error that prevents some SCC functionality.", "Describes a potential security risk due to a change in the security posture.", "Describes a combination of security issues that represent a more severe security problem when taken together.", - "Describes a potential security risk to data assets that contain sensitive data." + "Describes a potential security risk to data assets that contain sensitive data.", + "Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." ], "type": "string" }, @@ -6469,11 +6487,13 @@ "description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", - "GROUP_TYPE_TOXIC_COMBINATION" + "GROUP_TYPE_TOXIC_COMBINATION", + "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ "Default value.", - "Group represents a toxic combination." + "Group represents a toxic combination.", + "Group represents a chokepoint." ], "type": "string" } @@ -7252,12 +7272,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -7281,31 +7309,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -7316,6 +7357,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -7324,12 +7366,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -7353,31 +7403,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -7388,6 +7451,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -7441,12 +7505,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -7470,31 +7542,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -7505,6 +7590,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -7513,12 +7599,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -7542,31 +7636,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -7577,6 +7684,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -8577,11 +8685,13 @@ "description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", - "GROUP_TYPE_TOXIC_COMBINATION" + "GROUP_TYPE_TOXIC_COMBINATION", + "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ "Default value.", - "Group represents a toxic combination." + "Group represents a toxic combination.", + "Group represents a chokepoint." ], "type": "string" } @@ -8963,12 +9073,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -8992,31 +9110,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -9027,6 +9158,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -9035,12 +9167,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -9064,31 +9204,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -9099,6 +9252,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -9152,12 +9306,20 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "DATA_OBFUSCATION", + "DATA_OBFUSCATION_STEGANOGRAPHY", "AUTOMATED_EXFILTRATION", + "OBFUSCATED_FILES_OR_INFO", + "STEGANOGRAPHY", + "COMPILE_AFTER_DELIVERY", + "COMMAND_OBFUSCATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", + "SCHEDULED_TASK_JOB", + "CONTAINER_ORCHESTRATION_JOB", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -9181,31 +9343,44 @@ "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", + "MULTI_STAGE_CHANNELS", "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", "SHARED_MODULES", + "DATA_ENCODING", + "STANDARD_ENCODING", "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", + "CREATE_ACCOUNT", + "LOCAL_ACCOUNT", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", + "FIRMWARE_CORRUPTION", "RESOURCE_HIJACKING", "NETWORK_DENIAL_OF_SERVICE", "CLOUD_SERVICE_DISCOVERY", "STEAL_APPLICATION_ACCESS_TOKEN", "ACCOUNT_ACCESS_REMOVAL", + "TRANSFER_DATA_TO_CLOUD_ACCOUNT", "STEAL_WEB_SESSION_COOKIE", "CREATE_OR_MODIFY_SYSTEM_PROCESS", "EVENT_TRIGGERED_EXECUTION", + "BOOT_OR_LOGON_AUTOSTART_EXECUTION", + "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "COMPROMISE_HOST_SOFTWARE_BINARY", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "HIDE_ARTIFACTS", + "HIDDEN_FILES_AND_DIRECTORIES", + "HIDDEN_USERS", "EXFILTRATION_OVER_WEB_SERVICE", "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", @@ -9216,6 +9391,7 @@ "OBTAIN_CAPABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", + "STAGE_CAPABILITIES", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", @@ -9224,12 +9400,20 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1001", + "T1001.002", "T1020", + "T1027", + "T1027.003", + "T1027.004", + "T1027.010", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", + "T1053", + "T1053.007", "T1057", "T1059", "T1059.004", @@ -9253,31 +9437,44 @@ "T1098.003", "T1098.004", "T1098.006", + "T1104", "T1105", "T1106", "T1110", "T1129", + "T1132", + "T1132.001", "T1134", "T1134.001", + "T1136", + "T1136.001", "T1190", "T1204", "T1484", "T1485", "T1489", "T1490", + "T1495", "T1496", "T1498", "T1526", "T1528", "T1531", + "T1537", "T1539", "T1543", "T1546", + "T1547", + "T1547.006", "T1548", "T1552", + "T1554", "T1556", "T1562", "T1562.001", + "T1564", + "T1564.001", + "T1564.002", "T1567", "T1567.002", "T1568", @@ -9288,6 +9485,7 @@ "T1588", "T1595", "T1595.001", + "T1608", "T1609", "T1610", "T1611", @@ -9792,7 +9990,7 @@ "type": "object" }, "SecurityCenterSettings": { - "description": "Resource capturing the settings for Security Center. Next ID: 12", + "description": "Resource capturing the settings for Security Center.", "id": "SecurityCenterSettings", "properties": { "logSinkProject": { diff --git a/discovery/servicecontrol-v1.json b/discovery/servicecontrol-v1.json index 486a519b98d..7e108515a08 100644 --- a/discovery/servicecontrol-v1.json +++ b/discovery/servicecontrol-v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20250124", + "revision": "20250411", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -732,7 +732,7 @@ "id": "Distribution", "properties": { "bucketCounts": { - "description": "The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted.", + "description": "The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N]` is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted.", "items": { "format": "int64", "type": "string" diff --git a/discovery/servicedirectory-v1.json b/discovery/servicedirectory-v1.json index 4deb5db90c9..62c02c283d3 100644 --- a/discovery/servicedirectory-v1.json +++ b/discovery/servicedirectory-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -883,7 +889,7 @@ } } }, - "revision": "20240121", + "revision": "20250321", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/servicedirectory-v1beta1.json b/discovery/servicedirectory-v1beta1.json index 89cbb0a7f4a..50135c5c9cd 100644 --- a/discovery/servicedirectory-v1beta1.json +++ b/discovery/servicedirectory-v1beta1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -971,7 +977,7 @@ } } }, - "revision": "20240420", + "revision": "20250321", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index bd154d91cc8..8ceea753f85 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -830,7 +830,7 @@ } } }, - "revision": "20250228", + "revision": "20250414", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -2158,7 +2158,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": { diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 24dbaa530ed..9270b209198 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -381,7 +381,7 @@ ], "parameters": { "name": { - "description": "The resource name of the quota limit. An example name would be: `projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests`", + "description": "The resource name of the quota. An example name would be: `projects/123/services/serviceusage.googleapis.com/consumerQuotaMetrics/serviceusage.googleapis.com%2Fmutate_requests`", "location": "path", "pattern": "^[^/]+/[^/]+/services/[^/]+/consumerQuotaMetrics/[^/]+$", "required": true, @@ -964,7 +964,7 @@ } } }, - "revision": "20250313", + "revision": "20250417", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index 88ad3181630..dbfc7765f5f 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -26,7 +26,7 @@ "canonicalName": "Sheets", "description": "Reads and writes Google Sheets.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/sheets/", + "documentationLink": "https://developers.google.com/workspace/sheets/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -169,7 +169,7 @@ ] }, "get": { - "description": "Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.", + "description": "Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.", "flatPath": "v4/spreadsheets/{spreadsheetId}", "httpMethod": "GET", "id": "sheets.spreadsheets.get", @@ -177,6 +177,11 @@ "spreadsheetId" ], "parameters": { + "excludeTablesInBandedRanges": { + "description": "True if tables should be excluded in the banded ranges. False if not set.", + "location": "query", + "type": "boolean" + }, "includeGridData": { "description": "True if grid data should be returned. This parameter is ignored if a field mask was set in the request.", "location": "query", @@ -208,7 +213,7 @@ ] }, "getByDataFilter": { - "description": "Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.", + "description": "Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.", "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter", "httpMethod": "POST", "id": "sheets.spreadsheets.getByDataFilter", @@ -349,7 +354,7 @@ "values": { "methods": { "append": { - "description": "Appends values to a spreadsheet. The input range is used to search for existing data and find a \"table\" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.", + "description": "Appends values to a spreadsheet. The input range is used to search for existing data and find a \"table\" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.", "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append", "httpMethod": "POST", "id": "sheets.spreadsheets.values.append", @@ -377,7 +382,7 @@ "type": "string" }, "range": { - "description": "The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.", + "description": "The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.", "location": "path", "required": true, "type": "string" @@ -405,7 +410,7 @@ "enumDescriptions": [ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.", "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/sheets/api/guides/formats#about_date_time_values)." + "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)." ], "location": "query", "type": "string" @@ -541,7 +546,7 @@ "type": "string" }, "ranges": { - "description": "The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.", + "description": "The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.", "location": "query", "repeated": true, "type": "string" @@ -562,7 +567,7 @@ "enumDescriptions": [ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.", "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/sheets/api/guides/formats#about_date_time_values)." + "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)." ], "location": "query", "type": "string" @@ -678,7 +683,7 @@ ], "parameters": { "range": { - "description": "The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.", + "description": "The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear.", "location": "path", "required": true, "type": "string" @@ -742,7 +747,7 @@ "type": "string" }, "range": { - "description": "The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from.", + "description": "The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.", "location": "path", "required": true, "type": "string" @@ -763,7 +768,7 @@ "enumDescriptions": [ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.", "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/sheets/api/guides/formats#about_date_time_values)." + "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)." ], "location": "query", "type": "string" @@ -797,7 +802,7 @@ "type": "boolean" }, "range": { - "description": "The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.", + "description": "The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update.", "location": "path", "required": true, "type": "string" @@ -825,7 +830,7 @@ "enumDescriptions": [ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.", "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/sheets/api/guides/formats#about_date_time_values)." + "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)." ], "location": "query", "type": "string" @@ -870,7 +875,7 @@ } } }, - "revision": "20250211", + "revision": "20250415", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -1094,6 +1099,17 @@ }, "type": "object" }, + "AddTableRequest": { + "description": "Adds a new table to the spreadsheet.", + "id": "AddTableRequest", + "properties": { + "table": { + "$ref": "Table", + "description": "Required. The table to add." + } + }, + "type": "object" + }, "AppendCellsRequest": { "description": "Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.", "id": "AppendCellsRequest", @@ -1114,6 +1130,10 @@ "description": "The sheet ID to append the data to.", "format": "int32", "type": "integer" + }, + "tableId": { + "description": "The ID of the table to append data to. The data will be only appended to the table body. This field also takes precedence over the `sheet_id` field.", + "type": "string" } }, "type": "object" @@ -1605,6 +1625,10 @@ "$ref": "SortSpec" }, "type": "array" + }, + "tableId": { + "description": "The table this filter is backed by, if any. When writing, only one of range or table_id may be set.", + "type": "string" } }, "type": "object" @@ -1653,7 +1677,7 @@ "id": "BatchClearValuesByDataFilterResponse", "properties": { "clearedRanges": { - "description": "The ranges that were cleared, in [A1 notation](/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.", + "description": "The ranges that were cleared, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.", "items": { "type": "string" }, @@ -1671,7 +1695,7 @@ "id": "BatchClearValuesRequest", "properties": { "ranges": { - "description": "The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell).", + "description": "The ranges to clear, in [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell).", "items": { "type": "string" }, @@ -1745,7 +1769,7 @@ "enumDescriptions": [ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.", "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/sheets/api/guides/formats#about_date_time_values)." + "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)." ], "type": "string" } @@ -1876,7 +1900,7 @@ "enumDescriptions": [ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.", "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/sheets/api/guides/formats#about_date_time_values)." + "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)." ], "type": "string" }, @@ -1972,7 +1996,7 @@ "enumDescriptions": [ "Values will be calculated & formatted in the response according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return `\"$1.23\"`.", "Values will be calculated, but not formatted in the reply. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/sheets/api/guides/formats#about_date_time_values)." + "Values will not be calculated. The reply will include the formulas. For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency, then A2 would return `\"=A1\"`. Sheets treats date and time values as decimal values. This lets you perform arithmetic on them in formulas. For more information on interpreting date and time values, see [About date & time values](https://developers.google.com/workspace/sheets/api/guides/formats#about_date_time_values)." ], "type": "string" }, @@ -2994,7 +3018,7 @@ "properties": { "rgbColor": { "$ref": "Color", - "description": "RGB color. The [`alpha`](/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't generally supported." + "description": "RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't generally supported." }, "themeColor": { "description": "Theme color.", @@ -4065,6 +4089,17 @@ }, "type": "object" }, + "DeleteTableRequest": { + "description": "Removes the table with the given ID from the spreadsheet.", + "id": "DeleteTableRequest", + "properties": { + "tableId": { + "description": "The ID of the table to delete.", + "type": "string" + } + }, + "type": "object" + }, "DeveloperMetadata": { "description": "Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.", "id": "DeveloperMetadata", @@ -4592,12 +4627,12 @@ "type": "integer" }, "namedRangeId": { - "description": "The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set.", + "description": "The named range this filter view is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.", "type": "string" }, "range": { "$ref": "GridRange", - "description": "The range this filter view covers. When writing, only one of range or named_range_id may be set." + "description": "The range this filter view covers. When writing, only one of range or named_range_id or table_id may be set." }, "sortSpecs": { "description": "The sort order per column. Later specifications are used when values are equal in the earlier specifications.", @@ -4606,6 +4641,10 @@ }, "type": "array" }, + "tableId": { + "description": "The table this filter view is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.", + "type": "string" + }, "title": { "description": "The name of the filter view.", "type": "string" @@ -4700,6 +4739,10 @@ }, "type": "array" }, + "excludeTablesInBandedRanges": { + "description": "True if tables should be excluded in the banded ranges. False if not set.", + "type": "boolean" + }, "includeGridData": { "description": "True if grid data should be returned. This parameter is ignored if a field mask was set in the request.", "type": "boolean" @@ -5279,7 +5322,7 @@ "id": "NumberFormat", "properties": { "pattern": { - "description": "Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the [Date and Number Formats guide](/sheets/api/guides/formats) for more information about the supported patterns.", + "description": "Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for more information about the supported patterns.", "type": "string" }, "type": { @@ -5885,7 +5928,7 @@ "description": "The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection." }, "namedRangeId": { - "description": "The named range this protected range is backed by, if any. When writing, only one of range or named_range_id may be set.", + "description": "The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.", "type": "string" }, "protectedRangeId": { @@ -5895,12 +5938,16 @@ }, "range": { "$ref": "GridRange", - "description": "The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id may be set." + "description": "The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id or table_id may be set." }, "requestingUserCanEdit": { "description": "True if the user who requested this protected range can edit the protected area. This field is read-only.", "type": "boolean" }, + "tableId": { + "description": "The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.", + "type": "string" + }, "unprotectedRanges": { "description": "The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.", "items": { @@ -6083,6 +6130,10 @@ "$ref": "AddSlicerRequest", "description": "Adds a slicer." }, + "addTable": { + "$ref": "AddTableRequest", + "description": "Adds a table." + }, "appendCells": { "$ref": "AppendCellsRequest", "description": "Appends cells after the last row with data in a sheet." @@ -6171,6 +6222,10 @@ "$ref": "DeleteSheetRequest", "description": "Deletes a sheet." }, + "deleteTable": { + "$ref": "DeleteTableRequest", + "description": "A request for deleting a table." + }, "duplicateFilterView": { "$ref": "DuplicateFilterViewRequest", "description": "Duplicates a filter view." @@ -6306,6 +6361,10 @@ "updateSpreadsheetProperties": { "$ref": "UpdateSpreadsheetPropertiesRequest", "description": "Updates the spreadsheet's properties." + }, + "updateTable": { + "$ref": "UpdateTableRequest", + "description": "Updates a table." } }, "type": "object" @@ -6641,6 +6700,13 @@ "$ref": "Slicer" }, "type": "array" + }, + "tables": { + "description": "The tables on this sheet.", + "items": { + "$ref": "Table" + }, + "type": "array" } }, "type": "object" @@ -7005,6 +7071,128 @@ }, "type": "object" }, + "Table": { + "description": "A table.", + "id": "Table", + "properties": { + "columnProperties": { + "description": "The table column properties.", + "items": { + "$ref": "TableColumnProperties" + }, + "type": "array" + }, + "name": { + "description": "The table name. This is unique to all tables in the same spreadsheet.", + "type": "string" + }, + "range": { + "$ref": "GridRange", + "description": "The table range." + }, + "rowsProperties": { + "$ref": "TableRowsProperties", + "description": "The table rows properties." + }, + "tableId": { + "description": "The id of the table.", + "type": "string" + } + }, + "type": "object" + }, + "TableColumnDataValidationRule": { + "description": "A data validation rule for a column in a table.", + "id": "TableColumnDataValidationRule", + "properties": { + "condition": { + "$ref": "BooleanCondition", + "description": "The condition that data in the cell must match. Valid only if the [BooleanCondition.type] is ONE_OF_LIST." + } + }, + "type": "object" + }, + "TableColumnProperties": { + "description": "The table column.", + "id": "TableColumnProperties", + "properties": { + "columnIndex": { + "description": "The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet.", + "format": "int32", + "type": "integer" + }, + "columnName": { + "description": "The column name.", + "type": "string" + }, + "columnType": { + "description": "The column type.", + "enum": [ + "COLUMN_TYPE_UNSPECIFIED", + "DOUBLE", + "CURRENCY", + "PERCENT", + "DATE", + "TIME", + "DATE_TIME", + "TEXT", + "BOOLEAN", + "DROPDOWN", + "FILES_CHIP", + "PEOPLE_CHIP", + "FINANCE_CHIP", + "PLACE_CHIP", + "RATINGS_CHIP" + ], + "enumDescriptions": [ + "An unspecified column type.", + "The number column type.", + "The currency column type.", + "The percent column type.", + "The date column type.", + "The time column type.", + "The date and time column type.", + "The text column type.", + "The boolean column type.", + "The dropdown column type.", + "The files chip column type", + "The people chip column type", + "The finance chip column type", + "The place chip column type", + "The ratings chip column type" + ], + "type": "string" + }, + "dataValidationRule": { + "$ref": "TableColumnDataValidationRule", + "description": "The column data validation rule. Only set for dropdown column type." + } + }, + "type": "object" + }, + "TableRowsProperties": { + "description": "The table row properties.", + "id": "TableRowsProperties", + "properties": { + "firstBandColorStyle": { + "$ref": "ColorStyle", + "description": "The first color that is alternating. If this field is set, the first banded row is filled with the specified color. Otherwise, the first banded row is filled with a default color." + }, + "footerColorStyle": { + "$ref": "ColorStyle", + "description": "The color of the last row. If this field is not set a footer is not added, the last row is filled with either first_band_color_style or second_band_color_style, depending on the color of the previous row. If updating an existing table without a footer to have a footer, the range will be expanded by 1 row. If updating an existing table with a footer and removing a footer, the range will be shrunk by 1 row." + }, + "headerColorStyle": { + "$ref": "ColorStyle", + "description": "The color of the header row. If this field is set, the header row is filled with the specified color. Otherwise, the header row is filled with a default color." + }, + "secondBandColorStyle": { + "$ref": "ColorStyle", + "description": "The second color that is alternating. If this field is set, the second banded row is filled with the specified color. Otherwise, the second banded row is filled with a default color." + } + }, + "type": "object" + }, "TextFormat": { "description": "The format of a run of text in a cell. Absent values indicate that the field isn't specified.", "id": "TextFormat", @@ -7756,6 +7944,22 @@ }, "type": "object" }, + "UpdateTableRequest": { + "description": "Updates a table in the spreadsheet.", + "id": "UpdateTableRequest", + "properties": { + "fields": { + "description": "Required. The fields that should be updated. At least one field must be specified. The root `table` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, + "table": { + "$ref": "Table", + "description": "Required. The table to update." + } + }, + "type": "object" + }, "UpdateValuesByDataFilterResponse": { "description": "The response when updating a range of values by a data filter in a spreadsheet.", "id": "UpdateValuesByDataFilterResponse", @@ -7779,7 +7983,7 @@ "description": "The values of the cells in the range matched by the dataFilter after all updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`." }, "updatedRange": { - "description": "The range (in [A1 notation](/sheets/api/guides/concepts#cell)) that updates were applied to.", + "description": "The range (in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell)) that updates were applied to.", "type": "string" }, "updatedRows": { @@ -7843,7 +8047,7 @@ "type": "string" }, "range": { - "description": "The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.", + "description": "The range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.", "type": "string" }, "values": { diff --git a/discovery/slides-v1.json b/discovery/slides-v1.json index ec7b82d7e72..1dfa5cf1df5 100644 --- a/discovery/slides-v1.json +++ b/discovery/slides-v1.json @@ -32,7 +32,7 @@ "canonicalName": "Slides", "description": "Reads and writes Google Slides presentations.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/slides/", + "documentationLink": "https://developers.google.com/workspace/slides/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -246,7 +246,7 @@ ] }, "getThumbnail": { - "description": "Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](/slides/limits) for quota purposes.", + "description": "Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](https://developers.google.com/workspace/slides/limits) for quota purposes.", "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail", "httpMethod": "GET", "id": "slides.presentations.pages.getThumbnail", @@ -313,7 +313,7 @@ } } }, - "revision": "20250218", + "revision": "20250401", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { @@ -3039,7 +3039,7 @@ "type": "object" }, "Shape": { - "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).", + "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/workspace/slides/api/guides/transform).", "id": "Shape", "properties": { "placeholder": { @@ -3559,6 +3559,10 @@ "description": "Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive.", "type": "boolean" }, + "searchByRegex": { + "description": "Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching.", + "type": "boolean" + }, "text": { "description": "The text to search for in the shape or table.", "type": "string" diff --git a/discovery/solar-v1.json b/discovery/solar-v1.json index eac42ca5568..ccc05360e49 100644 --- a/discovery/solar-v1.json +++ b/discovery/solar-v1.json @@ -122,7 +122,7 @@ ], "enumDescriptions": [ "No experiments are specified.", - "Expands the geographic region available for querying solar data." + "Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." ], "location": "query", "repeated": true, @@ -154,7 +154,7 @@ "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", - "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." + "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. **Note:** This enum is only available if `experiments=EXPANDED_COVERAGE` is set in the request. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." ], "location": "query", "type": "string" @@ -192,7 +192,7 @@ ], "enumDescriptions": [ "No experiments are specified.", - "Expands the geographic region available for querying solar data." + "Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." ], "location": "query", "repeated": true, @@ -236,7 +236,7 @@ "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", - "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." + "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. **Note:** This enum is only available if `experiments=EXPANDED_COVERAGE` is set in the request. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." ], "location": "query", "type": "string" @@ -299,7 +299,7 @@ } } }, - "revision": "20250302", + "revision": "20250427", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { @@ -340,7 +340,7 @@ "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", - "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." + "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. **Note:** This enum is only available if `experiments=EXPANDED_COVERAGE` is set in the request. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." ], "type": "string" }, @@ -436,7 +436,7 @@ "Solar data is derived from aerial imagery captured at low-altitude and processed at 0.1 m/pixel.", "Solar data is derived from enhanced aerial imagery captured at high-altitude and processed at 0.25 m/pixel.", "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel.", - "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel." + "Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. **Note:** This enum is only available if `experiments=EXPANDED_COVERAGE` is set in the request. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." ], "type": "string" }, diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 939a1dc6009..89fd1259253 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20250310", + "revision": "20250412", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2710,7 +2710,7 @@ "type": "string" }, "databaseVersion": { - "description": "Output only. The database version of the instance of when this backup was made.", + "description": "Output only. The database version of the instance of at the time this backup was made.", "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", @@ -2731,7 +2731,6 @@ "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", @@ -2804,7 +2803,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -2827,7 +2825,6 @@ "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.", @@ -3137,7 +3134,7 @@ "type": "string" }, "databaseVersion": { - "description": "Output only. The instance database version when this backup was made.", + "description": "Output only. The instance database version at the time this backup was made.", "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", @@ -3158,7 +3155,6 @@ "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", @@ -3231,7 +3227,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -3254,7 +3249,6 @@ "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.", @@ -3488,16 +3482,16 @@ "type": "object" }, "ConnectPoolNodeConfig": { - "description": "Details of a single node of a read pool.", + "description": "Details of a single read pool node of a read pool.", "id": "ConnectPoolNodeConfig", "properties": { "dnsName": { - "description": "Output only. The DNS name of the node.", + "description": "Output only. The DNS name of the read pool node.", "readOnly": true, "type": "string" }, "dnsNames": { - "description": "Output only. The list of DNS names used by this node.", + "description": "Output only. The list of DNS names used by this read pool node.", "items": { "$ref": "DnsNameMapping" }, @@ -3505,7 +3499,7 @@ "type": "array" }, "ipAddresses": { - "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "description": "Output only. Mappings containing IP addresses that can be used to connect to the read pool node.", "items": { "$ref": "IpMapping" }, @@ -3513,7 +3507,7 @@ "type": "array" }, "name": { - "description": "Output only. The name of the node. Doesn't include the project ID.", + "description": "Output only. The name of the read pool node. Doesn't include the project ID.", "readOnly": true, "type": "string" } @@ -3575,7 +3569,6 @@ "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", @@ -3648,7 +3641,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -3671,7 +3663,6 @@ "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.", @@ -3725,12 +3716,12 @@ "type": "string" }, "nodeCount": { - "description": "The number of nodes in a read pool.", + "description": "The number of read pool nodes in a read pool.", "format": "int32", "type": "integer" }, "nodes": { - "description": "Output only. Entries containing information about each node of the read pool.", + "description": "Output only. Entries containing information about each read pool node of the read pool.", "items": { "$ref": "ConnectPoolNodeConfig" }, @@ -3772,18 +3763,6 @@ "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" @@ -3794,39 +3773,6 @@ "$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" @@ -3991,7 +3937,6 @@ "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", @@ -4064,7 +4009,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -4087,7 +4031,6 @@ "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.", @@ -4182,7 +4125,7 @@ "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.", - "CloudSQL read pool." + "A Cloud SQL read pool." ], "type": "string" }, @@ -4221,12 +4164,12 @@ "type": "string" }, "nodeCount": { - "description": "The number of nodes in a read pool.", + "description": "The number of read pool nodes in a read pool.", "format": "int32", "type": "integer" }, "nodes": { - "description": "Output only. Entries containing information about each node of the read pool.", + "description": "Output only. Entries containing information about each read pool node of the read pool.", "items": { "$ref": "PoolNodeConfig" }, @@ -4722,7 +4665,7 @@ "type": "string" }, "offload": { - "description": "Option for export offload.", + "description": "Whether to perform a serverless export.", "type": "boolean" }, "sqlExportOptions": { @@ -4747,7 +4690,7 @@ "description": "Options for exporting from a Cloud SQL for PostgreSQL instance.", "properties": { "clean": { - "description": "Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.", + "description": "Optional. Use this option to include DROP SQL statements. Use these statements to delete database objects before running the import operation.", "type": "boolean" }, "ifExists": { @@ -4874,7 +4817,6 @@ "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", @@ -4947,7 +4889,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -4970,7 +4911,6 @@ "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.", @@ -6183,7 +6123,7 @@ "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.", + "Repairs entire read pool or specified read pool nodes in the read pool.", "Creates a Cloud SQL read pool instance." ], "type": "string" @@ -6414,16 +6354,16 @@ "type": "object" }, "PoolNodeConfig": { - "description": "Details of a single node of a read pool.", + "description": "Details of a single read pool node of a read pool.", "id": "PoolNodeConfig", "properties": { "dnsName": { - "description": "Output only. The DNS name of the node.", + "description": "Output only. The DNS name of the read pool node.", "readOnly": true, "type": "string" }, "dnsNames": { - "description": "Output only. The list of DNS names used by this node.", + "description": "Output only. The list of DNS names used by this read pool node.", "items": { "$ref": "DnsNameMapping" }, @@ -6431,12 +6371,12 @@ "type": "array" }, "gceZone": { - "description": "Output only. The serving zone of the node.", + "description": "Output only. The zone of the read pool node.", "readOnly": true, "type": "string" }, "ipAddresses": { - "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "description": "Output only. Mappings containing IP addresses that can be used to connect to the read pool node.", "items": { "$ref": "IpMapping" }, @@ -6444,12 +6384,12 @@ "type": "array" }, "name": { - "description": "Output only. The name of the node, to be used for retrieving metrics and logs for the node.", + "description": "Output only. The name of the read pool node, to be used for retrieving metrics and logs.", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. The current state of the node.", + "description": "Output only. The current state of the read pool node.", "enum": [ "SQL_INSTANCE_STATE_UNSPECIFIED", "RUNNABLE", @@ -6849,7 +6789,7 @@ "type": "boolean" }, "enableGoogleMlIntegration": { - "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.", + "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances.", "type": "boolean" }, "insightsConfig": { @@ -7695,6 +7635,20 @@ "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.", "type": "string" }, + "iamStatus": { + "description": "Indicates if user is active for IAM Authentication.", + "enum": [ + "IAM_STATUS_UNSPECIFIED", + "INACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive/active. Will not display any value in UI.", + "User is not available for IAM Authentication.", + "User is available for IAM Authentication." + ], + "type": "string" + }, "instance": { "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.", "type": "string" diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 2ac5c7e81d8..9c54da41f4c 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20250310", + "revision": "20250412", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2710,7 +2710,7 @@ "type": "string" }, "databaseVersion": { - "description": "Output only. The database version of the instance of when this backup was made.", + "description": "Output only. The database version of the instance of at the time this backup was made.", "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", @@ -2731,7 +2731,6 @@ "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", @@ -2804,7 +2803,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -2827,7 +2825,6 @@ "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.", @@ -3137,7 +3134,7 @@ "type": "string" }, "databaseVersion": { - "description": "Output only. The instance database version when this backup was made.", + "description": "Output only. The instance database version at the time this backup was made.", "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_1", @@ -3158,7 +3155,6 @@ "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", @@ -3231,7 +3227,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -3254,7 +3249,6 @@ "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.", @@ -3488,16 +3482,16 @@ "type": "object" }, "ConnectPoolNodeConfig": { - "description": "Details of a single node of a read pool.", + "description": "Details of a single read pool node of a read pool.", "id": "ConnectPoolNodeConfig", "properties": { "dnsName": { - "description": "Output only. The DNS name of the node.", + "description": "Output only. The DNS name of the read pool node.", "readOnly": true, "type": "string" }, "dnsNames": { - "description": "Output only. The list of DNS names used by this instance.", + "description": "Output only. The list of DNS names used by this read pool node.", "items": { "$ref": "DnsNameMapping" }, @@ -3505,7 +3499,7 @@ "type": "array" }, "ipAddresses": { - "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "description": "Output only. Mappings containing IP addresses that can be used to connect to the read pool node.", "items": { "$ref": "IpMapping" }, @@ -3513,7 +3507,7 @@ "type": "array" }, "name": { - "description": "Output only. The name of the node. Doesn't include the project ID.", + "description": "Output only. The name of the read pool node. Doesn't include the project ID.", "readOnly": true, "type": "string" } @@ -3575,7 +3569,6 @@ "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", @@ -3648,7 +3641,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -3671,7 +3663,6 @@ "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.", @@ -3725,12 +3716,12 @@ "type": "string" }, "nodeCount": { - "description": "The number of nodes in a read pool.", + "description": "The number of read pool nodes in a read pool.", "format": "int32", "type": "integer" }, "nodes": { - "description": "Output only. Entries containing information about each node of the read pool.", + "description": "Output only. Entries containing information about each read pool node of the read pool.", "items": { "$ref": "ConnectPoolNodeConfig" }, @@ -3772,18 +3763,6 @@ "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" @@ -3794,39 +3773,6 @@ "$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" @@ -3991,7 +3937,6 @@ "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", @@ -4064,7 +4009,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -4087,7 +4031,6 @@ "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.", @@ -4182,7 +4125,7 @@ "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.", - "CloudSQL read pool." + "A Cloud SQL read pool." ], "type": "string" }, @@ -4221,12 +4164,12 @@ "type": "string" }, "nodeCount": { - "description": "The number of nodes in a read pool.", + "description": "The number of read pool nodes in a read pool.", "format": "int32", "type": "integer" }, "nodes": { - "description": "Output only. Entries containing information about each node of the read pool.", + "description": "Output only. Entries containing information about each read pool node of the read pool.", "items": { "$ref": "PoolNodeConfig" }, @@ -4723,7 +4666,7 @@ "type": "string" }, "offload": { - "description": "Option for export offload.", + "description": "Whether to perform a serverless export.", "type": "boolean" }, "sqlExportOptions": { @@ -4748,7 +4691,7 @@ "description": "Options for exporting from a Cloud SQL for PostgreSQL instance.", "properties": { "clean": { - "description": "Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.", + "description": "Optional. Use this option to include DROP SQL statements. Use these statements to delete database objects before running the import operation.", "type": "boolean" }, "ifExists": { @@ -4875,7 +4818,6 @@ "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", @@ -4948,7 +4890,6 @@ false, false, false, - false, false ], "enumDescriptions": [ @@ -4971,7 +4912,6 @@ "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.", @@ -6184,7 +6124,7 @@ "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.", + "Repairs entire read pool or specified read pool nodes in the read pool.", "Creates a Cloud SQL read pool instance." ], "type": "string" @@ -6415,16 +6355,16 @@ "type": "object" }, "PoolNodeConfig": { - "description": "Details of a single node of a read pool.", + "description": "Details of a single read pool node of a read pool.", "id": "PoolNodeConfig", "properties": { "dnsName": { - "description": "Output only. The DNS name of the node.", + "description": "Output only. The DNS name of the read pool node.", "readOnly": true, "type": "string" }, "dnsNames": { - "description": "Output only. The list of DNS names used by this node.", + "description": "Output only. The list of DNS names used by this read pool node.", "items": { "$ref": "DnsNameMapping" }, @@ -6432,12 +6372,12 @@ "type": "array" }, "gceZone": { - "description": "Output only. The serving zone of the node.", + "description": "Output only. The zone of the read pool node.", "readOnly": true, "type": "string" }, "ipAddresses": { - "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "description": "Output only. Mappings containing IP addresses that can be used to connect to the read pool node.", "items": { "$ref": "IpMapping" }, @@ -6445,12 +6385,12 @@ "type": "array" }, "name": { - "description": "Output only. The name of the node, to be used for retrieving metrics and logs for the node.", + "description": "Output only. The name of the read pool node, to be used for retrieving metrics and logs.", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. The current state of the node.", + "description": "Output only. The current state of the read pool node.", "enum": [ "SQL_INSTANCE_STATE_UNSPECIFIED", "RUNNABLE", @@ -6850,7 +6790,7 @@ "type": "boolean" }, "enableGoogleMlIntegration": { - "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.", + "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances.", "type": "boolean" }, "insightsConfig": { @@ -7694,6 +7634,20 @@ "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.", "type": "string" }, + "iamStatus": { + "description": "Indicates if user is active for IAM Authentication.", + "enum": [ + "IAM_STATUS_UNSPECIFIED", + "INACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive/active. Will not display any value in UI.", + "User is not available for IAM Authentication.", + "User is available for IAM Authentication." + ], + "type": "string" + }, "instance": { "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL.", "type": "string" diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index 7200b6723b8..3d82bb4d974 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -52,6 +52,11 @@ "endpointUrl": "https://storage.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://storage.asia-south1.rep.googleapis.com/", @@ -206,9 +211,34 @@ "description": "Regional Endpoint", "endpointUrl": "https://storage.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" } ], - "etag": "\"363938303832303939373531303639383731\"", + "etag": "\"38353737343034333936303735343633323432\"", "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" @@ -227,10 +257,12 @@ "default": "json", "description": "Data format for the response.", "enum": [ - "json" + "json", + "media" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "Responses with Content-Type of application/json", + "Responses containing object data" ], "location": "query", "type": "string" @@ -3409,6 +3441,19 @@ "location": "query", "type": "string" }, + "projection": { + "description": "Set of properties to return. Defaults to noAcl.", + "enum": [ + "full", + "noAcl" + ], + "enumDescriptions": [ + "Include all properties.", + "Omit the owner, acl property." + ], + "location": "query", + "type": "string" + }, "sourceObject": { "description": "Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", @@ -4479,7 +4524,7 @@ } } }, - "revision": "20250312", + "revision": "20250424", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { diff --git a/discovery/storagebatchoperations-v1.json b/discovery/storagebatchoperations-v1.json new file mode 100644 index 00000000000..cd9077f6543 --- /dev/null +++ b/discovery/storagebatchoperations-v1.json @@ -0,0 +1,1105 @@ +{ + "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://storagebatchoperations.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Storage Batch Operations", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/storage/docs/batch-operations/overview", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "storagebatchoperations:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://storagebatchoperations.mtls.googleapis.com/", + "name": "storagebatchoperations", + "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": "storagebatchoperations.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": "storagebatchoperations.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, + "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": { + "jobs": { + "methods": { + "cancel": { + "description": "Cancels a batch job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:cancel", + "httpMethod": "POST", + "id": "storagebatchoperations.projects.locations.jobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The `name` of the job to cancel. Format: projects/{project_id}/locations/global/jobs/{job_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelJobRequest" + }, + "response": { + "$ref": "CancelJobResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a batch job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs", + "httpMethod": "POST", + "id": "storagebatchoperations.projects.locations.jobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "jobId": { + "description": "Required. The optional `job_id` for this Job . If not specified, an id is generated. `job_id` should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/jobs", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a batch job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", + "httpMethod": "DELETE", + "id": "storagebatchoperations.projects.locations.jobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The `name` of the job to delete. Format: projects/{project_id}/locations/global/jobs/{job_id} .", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a batch job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", + "httpMethod": "GET", + "id": "storagebatchoperations.projects.locations.jobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. `name` of the job to retrieve. Format: projects/{project_id}/locations/global/jobs/{job_id} .", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Jobs in a given project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs", + "httpMethod": "GET", + "id": "storagebatchoperations.projects.locations.jobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filters results as defined by https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field to sort by. Supported fields are name, create_time.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The list page size. default page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: projects/{project_id}/locations/global.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/jobs", + "response": { + "$ref": "ListJobsResponse" + }, + "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": "storagebatchoperations.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": "storagebatchoperations.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": "storagebatchoperations.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": "storagebatchoperations.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": "20250409", + "rootUrl": "https://storagebatchoperations.googleapis.com/", + "schemas": { + "Bucket": { + "description": "Describes configuration of a single bucket and its objects to be transformed.", + "id": "Bucket", + "properties": { + "bucket": { + "description": "Required. Bucket name for the objects to be transformed.", + "type": "string" + }, + "manifest": { + "$ref": "Manifest", + "description": "Specifies objects in a manifest file." + }, + "prefixList": { + "$ref": "PrefixList", + "description": "Specifies objects matching a prefix set." + } + }, + "type": "object" + }, + "BucketList": { + "description": "Describes list of buckets and their objects to be transformed.", + "id": "BucketList", + "properties": { + "buckets": { + "description": "Required. List of buckets and their objects to be transformed. Currently, only one bucket configuration is supported. If multiple buckets are specified, an error will be returned.", + "items": { + "$ref": "Bucket" + }, + "type": "array" + } + }, + "type": "object" + }, + "CancelJobRequest": { + "description": "Message for Job to Cancel", + "id": "CancelJobRequest", + "properties": { + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "CancelJobResponse": { + "description": "Message for response to cancel Job.", + "id": "CancelJobResponse", + "properties": {}, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Counters": { + "description": "Describes details about the progress of the job.", + "id": "Counters", + "properties": { + "failedObjectCount": { + "description": "Output only. Number of objects failed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "succeededObjectCount": { + "description": "Output only. Number of objects completed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "totalObjectCount": { + "description": "Output only. Number of objects listed.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DeleteObject": { + "description": "Describes options to delete an object.", + "id": "DeleteObject", + "properties": { + "permanentObjectDeletionEnabled": { + "description": "Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.", + "type": "boolean" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ErrorLogEntry": { + "description": "An entry describing an error that has occurred.", + "id": "ErrorLogEntry", + "properties": { + "errorDetails": { + "description": "Optional. Output only. At most 5 error log entries are recorded for a given error code for a job.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "objectUri": { + "description": "Required. Output only. Object URL. e.g. gs://my_bucket/object.txt", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ErrorSummary": { + "description": "A summary of errors by error code, plus a count and sample error log entries.", + "id": "ErrorSummary", + "properties": { + "errorCode": { + "description": "Required. The canonical error code.", + "enum": [ + "OK", + "CANCELLED", + "UNKNOWN", + "INVALID_ARGUMENT", + "DEADLINE_EXCEEDED", + "NOT_FOUND", + "ALREADY_EXISTS", + "PERMISSION_DENIED", + "UNAUTHENTICATED", + "RESOURCE_EXHAUSTED", + "FAILED_PRECONDITION", + "ABORTED", + "OUT_OF_RANGE", + "UNIMPLEMENTED", + "INTERNAL", + "UNAVAILABLE", + "DATA_LOSS" + ], + "enumDescriptions": [ + "Not an error; returned on success. HTTP Mapping: 200 OK", + "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", + "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", + "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", + "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", + "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", + "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", + "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", + "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", + "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", + "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", + "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", + "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", + "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", + "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" + ], + "type": "string" + }, + "errorCount": { + "description": "Required. Number of errors encountered per `error_code`.", + "format": "int64", + "type": "string" + }, + "errorLogEntries": { + "description": "Required. Sample error logs.", + "items": { + "$ref": "ErrorLogEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "Job": { + "description": "The Storage Batch Operations Job description.", + "id": "Job", + "properties": { + "bucketList": { + "$ref": "BucketList", + "description": "Specifies a list of buckets and their objects to be transformed." + }, + "completeTime": { + "description": "Output only. The time that the job was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "counters": { + "$ref": "Counters", + "description": "Output only. Information about the progress of the job.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The time that the job was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteObject": { + "$ref": "DeleteObject", + "description": "Delete objects." + }, + "description": { + "description": "Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.", + "type": "string" + }, + "errorSummaries": { + "description": "Output only. Summarizes errors encountered with sample error log entries.", + "items": { + "$ref": "ErrorSummary" + }, + "readOnly": true, + "type": "array" + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. Logging configuration." + }, + "name": { + "description": "Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: \"projects/123456/locations/global/jobs/job01\".", + "type": "string" + }, + "putMetadata": { + "$ref": "PutMetadata", + "description": "Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time." + }, + "putObjectHold": { + "$ref": "PutObjectHold", + "description": "Changes object hold status." + }, + "rewriteObject": { + "$ref": "RewriteObject", + "description": "Rewrite the object and updates metadata like KMS key." + }, + "scheduleTime": { + "description": "Output only. The time that the job was scheduled.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the job.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "SUCCEEDED", + "CANCELED", + "FAILED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "In progress.", + "Completed successfully.", + "Cancelled by the user.", + "Terminated due to an unrecoverable failure." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListJobsResponse": { + "description": "Message for response to listing Jobs", + "id": "ListJobsResponse", + "properties": { + "jobs": { + "description": "A list of storage batch jobs.", + "items": { + "$ref": "Job" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "LoggingConfig": { + "description": "Specifies the Cloud Logging behavior.", + "id": "LoggingConfig", + "properties": { + "logActionStates": { + "description": "Required. States in which Action are logged.If empty, no logs are generated.", + "items": { + "enum": [ + "LOGGABLE_ACTION_STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Illegal value, to avoid allowing a default.", + "`LoggableAction` completed successfully. `SUCCEEDED` actions are logged as INFO.", + "`LoggableAction` terminated in an error state. `FAILED` actions are logged as ERROR." + ], + "type": "string" + }, + "type": "array" + }, + "logActions": { + "description": "Required. Specifies the actions to be logged.", + "items": { + "enum": [ + "LOGGABLE_ACTION_UNSPECIFIED", + "TRANSFORM" + ], + "enumDescriptions": [ + "Illegal value, to avoid allowing a default.", + "The corresponding transform action in this job." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Manifest": { + "description": "Describes list of objects to be transformed.", + "id": "Manifest", + "properties": { + "manifestLocation": { + "description": "Required. `manifest_location` must contain the manifest source file that is a CSV file in a Google Cloud Storage bucket. Each row in the file must include the object details i.e. BucketId and Name. Generation may optionally be specified. When it is not specified the live object is acted upon. `manifest_location` should either be 1) An absolute path to the object in the format of `gs://bucket_name/path/file_name.csv`. 2) An absolute path with a single wildcard character in the file name, for example `gs://bucket_name/path/file_name*.csv`. If manifest location is specified with a wildcard, objects in all manifest files matching the pattern will be acted upon.", + "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" + }, + "job": { + "$ref": "Job", + "description": "Output only. The Job associated with the operation.", + "readOnly": true + }, + "operation": { + "description": "Output only. The unique operation resource name. Format: projects/{project}/locations/global/operations/{operation}.", + "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 google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "PrefixList": { + "description": "Describes prefixes of objects to be transformed.", + "id": "PrefixList", + "properties": { + "includedObjectPrefixes": { + "description": "Optional. Include prefixes of the objects to be transformed. * Supports full object name * Supports prefix of the object name * Wildcards are not supported * Supports empty string for all objects in a bucket.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PutMetadata": { + "description": "Describes options for object metadata update.", + "id": "PutMetadata", + "properties": { + "cacheControl": { + "description": "Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data.", + "type": "string" + }, + "contentDisposition": { + "description": "Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation.", + "type": "string" + }, + "contentEncoding": { + "description": "Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding.", + "type": "string" + }, + "contentLanguage": { + "description": "Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language.", + "type": "string" + }, + "contentType": { + "description": "Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type", + "type": "string" + }, + "customMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata", + "type": "object" + }, + "customTime": { + "description": "Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.", + "type": "string" + } + }, + "type": "object" + }, + "PutObjectHold": { + "description": "Describes options to update object hold.", + "id": "PutObjectHold", + "properties": { + "eventBasedHold": { + "description": "Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.", + "enum": [ + "HOLD_STATUS_UNSPECIFIED", + "SET", + "UNSET" + ], + "enumDescriptions": [ + "Default value, Object hold status will not be changed.", + "Places the hold.", + "Releases the hold." + ], + "type": "string" + }, + "temporaryHold": { + "description": "Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.", + "enum": [ + "HOLD_STATUS_UNSPECIFIED", + "SET", + "UNSET" + ], + "enumDescriptions": [ + "Default value, Object hold status will not be changed.", + "Places the hold.", + "Releases the hold." + ], + "type": "string" + } + }, + "type": "object" + }, + "RewriteObject": { + "description": "Describes options for object rewrite.", + "id": "RewriteObject", + "properties": { + "kmsKey": { + "description": "Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} For example: \"projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key\". The object will be rewritten and set with the specified KMS key.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Storage Batch Operations API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index 0f731d1a341..711d0ac60d6 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -632,7 +632,7 @@ } } }, - "revision": "20250301", + "revision": "20250426", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -1056,12 +1056,14 @@ "enum": [ "LOGGABLE_ACTION_STATE_UNSPECIFIED", "SUCCEEDED", - "FAILED" + "FAILED", + "SKIPPED" ], "enumDescriptions": [ "Default value. This value is unused.", "`LoggableAction` completed successfully. `SUCCEEDED` actions are logged as INFO.", - "`LoggableAction` terminated in an error state. `FAILED` actions are logged as ERROR." + "`LoggableAction` terminated in an error state. `FAILED` actions are logged as ERROR.", + "The `COPY` action was skipped for this file. Only supported for agent-based transfers. `SKIPPED` actions are logged as INFO." ], "type": "string" }, diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index dc73dbc4923..571a516394c 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -7,26 +7,161 @@ "discoveryVersion": "v1", "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.europe-west1.rep.googleapis.com/", "location": "europe-west1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.europe-west4.rep.googleapis.com/", "location": "europe-west4" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-central1.rep.googleapis.com/", @@ -42,15 +177,50 @@ "endpointUrl": "https://sts.us-east1.rep.googleapis.com/", "location": "us-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-east7.rep.googleapis.com/", "location": "us-east7" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-west1.rep.googleapis.com/", "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -163,7 +333,7 @@ } } }, - "revision": "20250303", + "revision": "20250331", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/discovery/sts-v1beta.json b/discovery/sts-v1beta.json index 0f226c1c64c..2cccbb44256 100644 --- a/discovery/sts-v1beta.json +++ b/discovery/sts-v1beta.json @@ -7,26 +7,161 @@ "discoveryVersion": "v1", "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.europe-west1.rep.googleapis.com/", "location": "europe-west1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.europe-west4.rep.googleapis.com/", "location": "europe-west4" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-central1.rep.googleapis.com/", @@ -42,15 +177,50 @@ "endpointUrl": "https://sts.us-east1.rep.googleapis.com/", "location": "us-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-east7.rep.googleapis.com/", "location": "us-east7" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-west1.rep.googleapis.com/", "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -163,7 +333,7 @@ } } }, - "revision": "20250303", + "revision": "20250331", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/discovery/tagmanager-v1.json b/discovery/tagmanager-v1.json index 2fe3b7b0709..9e9a9178c99 100644 --- a/discovery/tagmanager-v1.json +++ b/discovery/tagmanager-v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20250310", + "revision": "20250409", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -2391,14 +2391,6 @@ }, "type": "array" }, - "macro": { - "deprecated": true, - "description": "The macros in the container that this version was taken from.", - "items": { - "$ref": "Macro" - }, - "type": "array" - }, "name": { "description": "Container version display name.", "type": "string" @@ -2407,14 +2399,6 @@ "description": "User notes on how to apply this container version in the container.", "type": "string" }, - "rule": { - "deprecated": true, - "description": "The rules in the container that this version was taken from.", - "items": { - "$ref": "Rule" - }, - "type": "array" - }, "tag": { "description": "The tags in the container that this version was taken from.", "items": { @@ -2463,16 +2447,6 @@ "description": "Container version display name.", "type": "string" }, - "numMacros": { - "deprecated": true, - "description": "Number of macros in the container version.", - "type": "string" - }, - "numRules": { - "deprecated": true, - "description": "Number of rules in the container version.", - "type": "string" - }, "numTags": { "description": "Number of tags in the container version.", "type": "string" @@ -2777,76 +2751,6 @@ }, "type": "object" }, - "Macro": { - "description": "Represents a Google Tag Manager Macro.", - "id": "Macro", - "properties": { - "accountId": { - "description": "GTM Account ID.", - "type": "string" - }, - "containerId": { - "description": "GTM Container ID.", - "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.", - "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "fingerprint": { - "description": "The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.", - "type": "string" - }, - "macroId": { - "description": "The Macro ID uniquely identifies the GTM Macro.", - "type": "string" - }, - "name": { - "description": "Macro display name.", - "type": "string" - }, - "notes": { - "description": "User notes on how to apply this macro in the container.", - "type": "string" - }, - "parameter": { - "description": "The macro's parameters.", - "items": { - "$ref": "Parameter" - }, - "type": "array" - }, - "parentFolderId": { - "description": "Parent folder id.", - "type": "string" - }, - "scheduleEndMs": { - "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.", - "format": "int64", - "type": "string" - }, - "type": { - "description": "GTM Macro Type.", - "type": "string" - } - }, - "type": "object" - }, "Parameter": { "description": "Represents a Google Tag Manager Parameter.", "id": "Parameter", @@ -2913,44 +2817,6 @@ }, "type": "object" }, - "Rule": { - "description": "Represents a Google Tag Manager Rule.", - "id": "Rule", - "properties": { - "accountId": { - "description": "GTM Account ID.", - "type": "string" - }, - "condition": { - "description": "The list of conditions that make up this rule (implicit AND between them).", - "items": { - "$ref": "Condition" - }, - "type": "array" - }, - "containerId": { - "description": "GTM Container ID.", - "type": "string" - }, - "fingerprint": { - "description": "The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.", - "type": "string" - }, - "name": { - "description": "Rule display name.", - "type": "string" - }, - "notes": { - "description": "User notes on how to apply this rule in the container.", - "type": "string" - }, - "ruleId": { - "description": "The Rule ID uniquely identifies the GTM Rule.", - "type": "string" - } - }, - "type": "object" - }, "SetupTag": { "id": "SetupTag", "properties": { @@ -2973,14 +2839,6 @@ "description": "GTM Account ID.", "type": "string" }, - "blockingRuleId": { - "deprecated": true, - "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.", "items": { @@ -2996,14 +2854,6 @@ "description": "The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.", "type": "string" }, - "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.", - "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.", "items": { diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json index 999720282a5..e02df9a5ed9 100644 --- a/discovery/tagmanager-v2.json +++ b/discovery/tagmanager-v2.json @@ -3940,7 +3940,7 @@ } } }, - "revision": "20250310", + "revision": "20250409", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -4723,16 +4723,6 @@ "description": "Number of Google tag configs in the container version.", "type": "string" }, - "numMacros": { - "deprecated": true, - "description": "Number of macros in the container version.", - "type": "string" - }, - "numRules": { - "deprecated": true, - "description": "Number of rules in the container version.", - "type": "string" - }, "numTags": { "description": "Number of tags in the container version.", "type": "string" @@ -5798,14 +5788,6 @@ "description": "GTM Account ID.", "type": "string" }, - "blockingRuleId": { - "deprecated": true, - "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.", "items": { @@ -5825,14 +5807,6 @@ "description": "The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.", "type": "string" }, - "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.", - "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.", "items": { diff --git a/discovery/tasks-v1.json b/discovery/tasks-v1.json index f90fafbd65d..25cff4aa782 100644 --- a/discovery/tasks-v1.json +++ b/discovery/tasks-v1.json @@ -379,7 +379,7 @@ ] }, "list": { - "description": "Returns all tasks in the specified task list. Does not return assigned tasks be default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.", + "description": "Returns all tasks in the specified task list. Doesn't return assigned tasks by default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.", "flatPath": "tasks/v1/lists/{tasklist}/tasks", "httpMethod": "GET", "id": "tasks.tasks.list", @@ -576,7 +576,7 @@ } } }, - "revision": "20250316", + "revision": "20250415", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "AssignmentInfo": { diff --git a/discovery/testing-v1.json b/discovery/testing-v1.json index 7a28f144f76..bbb23eb0ba7 100644 --- a/discovery/testing-v1.json +++ b/discovery/testing-v1.json @@ -431,6 +431,11 @@ "required": true, "type": "string" }, + "includeViewableModels": { + "description": "Optional. Whether to include viewable only models in the response. This is only applicable for Android models.", + "location": "query", + "type": "boolean" + }, "projectId": { "description": "For authorization, the cloud project requesting the TestEnvironmentCatalog.", "location": "query", @@ -449,7 +454,7 @@ } } }, - "revision": "20250304", + "revision": "20250327", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -620,6 +625,21 @@ "description": "A description of an Android device tests may be run on.", "id": "AndroidModel", "properties": { + "accessDeniedReasons": { + "description": "Reasons for access denial. This model is accessible if this list is empty, otherwise the model is viewable only.", + "items": { + "enum": [ + "ACCESS_DENIED_REASON_UNSPECIFIED", + "EULA_NOT_ACCEPTED" + ], + "enumDescriptions": [ + "Do not use. For proto versioning only.", + "The model is for viewing purposes only. Access and utilization require acceptance of an End User License Agreement (EULA)." + ], + "type": "string" + }, + "type": "array" + }, "brand": { "description": "The company that this device is branded with. Example: \"Google\", \"Samsung\".", "type": "string" diff --git a/discovery/texttospeech-v1.json b/discovery/texttospeech-v1.json index ae28c659bba..06d7de39c69 100644 --- a/discovery/texttospeech-v1.json +++ b/discovery/texttospeech-v1.json @@ -318,7 +318,7 @@ } } }, - "revision": "20250114", + "revision": "20250415", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -376,7 +376,7 @@ "type": "integer" }, "speakingRate": { - "description": "Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", + "description": "Optional. Input only. Speaking rate/speed, in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 2.0 will return an error.", "format": "double", "type": "number" }, @@ -606,7 +606,7 @@ "properties": { "customPronunciations": { "$ref": "CustomPronunciations", - "description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag." + "description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag." }, "multiSpeakerMarkup": { "$ref": "MultiSpeakerMarkup", diff --git a/discovery/texttospeech-v1beta1.json b/discovery/texttospeech-v1beta1.json index 556b2813acb..7cca7347760 100644 --- a/discovery/texttospeech-v1beta1.json +++ b/discovery/texttospeech-v1beta1.json @@ -261,7 +261,7 @@ } } }, - "revision": "20250114", + "revision": "20250415", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -321,7 +321,7 @@ "type": "integer" }, "speakingRate": { - "description": "Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", + "description": "Optional. Input only. Speaking rate/speed, in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 2.0 will return an error.", "format": "double", "type": "number" }, @@ -539,7 +539,7 @@ "properties": { "customPronunciations": { "$ref": "CustomPronunciations", - "description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag." + "description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag." }, "multiSpeakerMarkup": { "$ref": "MultiSpeakerMarkup", diff --git a/discovery/tpu-v1.json b/discovery/tpu-v1.json index e97703fbc60..db44afe2fbf 100644 --- a/discovery/tpu-v1.json +++ b/discovery/tpu-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -659,7 +665,7 @@ } } }, - "revision": "20241126", + "revision": "20250320", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/discovery/tpu-v1alpha1.json b/discovery/tpu-v1alpha1.json index 4cdfd9862e6..99fe86d99f0 100644 --- a/discovery/tpu-v1alpha1.json +++ b/discovery/tpu-v1alpha1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -669,7 +675,7 @@ } } }, - "revision": "20241126", + "revision": "20250320", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/discovery/tpu-v2.json b/discovery/tpu-v2.json index ff4b8adef41..9a14274817d 100644 --- a/discovery/tpu-v2.json +++ b/discovery/tpu-v2.json @@ -171,6 +171,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -887,7 +893,7 @@ } } }, - "revision": "20250116", + "revision": "20250410", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1584,6 +1590,11 @@ "type": "string" }, "type": "array" + }, + "upcomingMaintenance": { + "$ref": "UpcomingMaintenance", + "description": "Output only. Upcoming maintenance on this TPU node.", + "readOnly": true } }, "type": "object" @@ -2046,6 +2057,57 @@ } }, "type": "object" + }, + "UpcomingMaintenance": { + "description": "Upcoming Maintenance notification information.", + "id": "UpcomingMaintenance", + "properties": { + "canReschedule": { + "description": "Indicates if the maintenance can be customer triggered.", + "type": "boolean" + }, + "latestWindowStartTime": { + "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.", + "type": "string" + }, + "maintenanceStatus": { + "description": "The status of the maintenance.", + "enum": [ + "UNKNOWN", + "PENDING", + "ONGOING" + ], + "enumDescriptions": [ + "Unknown maintenance status. Do not use this value.", + "There is pending maintenance.", + "There is ongoing maintenance on this VM." + ], + "type": "string" + }, + "type": { + "description": "Defines the type of maintenance.", + "enum": [ + "UNKNOWN_TYPE", + "SCHEDULED", + "UNSCHEDULED" + ], + "enumDescriptions": [ + "No type specified. Do not use this value.", + "Scheduled maintenance (e.g. maintenance after uptime guarantee is complete).", + "Unscheduled maintenance (e.g. emergency maintenance during uptime guarantee)." + ], + "type": "string" + }, + "windowEndTime": { + "description": "The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.", + "type": "string" + }, + "windowStartTime": { + "description": "The current start time of the maintenance window. This timestamp value is in RFC3339 text format.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/tpu-v2alpha1.json b/discovery/tpu-v2alpha1.json index d1b51dd4d7a..7e7e03cc757 100644 --- a/discovery/tpu-v2alpha1.json +++ b/discovery/tpu-v2alpha1.json @@ -171,6 +171,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1021,7 +1027,7 @@ } } }, - "revision": "20250306", + "revision": "20250423", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1149,9 +1155,28 @@ "$ref": "CustomerEncryptionKey", "description": "Optional. Customer encryption key for boot disk." }, + "diskSizeGb": { + "description": "Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image.", + "format": "int64", + "type": "string" + }, "enableConfidentialCompute": { "description": "Optional. Whether the boot disk will be created with confidential compute mode.", "type": "boolean" + }, + "provisionedIops": { + "description": "Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops).", + "format": "int64", + "type": "string" + }, + "provisionedThroughput": { + "description": "Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.", + "format": "int64", + "type": "string" + }, + "sourceImage": { + "description": "Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`.", + "type": "string" } }, "type": "object" @@ -1951,6 +1976,24 @@ "readOnly": true, "type": "string" }, + "provisioningModel": { + "description": "Optional. The provisioning model for the resource.", + "enum": [ + "PROVISIONING_MODEL_UNSPECIFIED", + "STANDARD", + "SPOT", + "RESERVATION_BOUND", + "FLEX_START" + ], + "enumDescriptions": [ + "Provisioning model is unknown.", + "Standard provisioning with user controlled runtime.", + "Spot provisioning with no guaranteed runtime.", + "Reservation provisioning with runtime bound to the lifetime of the consumed reservation.", + "Provisioning with DWS Flex Start with max run duration." + ], + "type": "string" + }, "queueingPolicy": { "$ref": "QueueingPolicy", "description": "The queueing policy of the QueuedRequest." @@ -1959,6 +2002,10 @@ "description": "Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}", "type": "string" }, + "runDuration": { + "$ref": "RunDuration", + "description": "Optional. The duration of the requested resource." + }, "spot": { "$ref": "Spot", "description": "Optional. The Spot tier." @@ -2132,6 +2179,23 @@ "properties": {}, "type": "object" }, + "RunDuration": { + "description": "Defines the maximum lifetime of the requested resource.", + "id": "RunDuration", + "properties": { + "maxRunDuration": { + "description": "The maximum duration of the requested resource.", + "format": "google-duration", + "type": "string" + }, + "terminationTime": { + "description": "The time at which the requested resource will be terminated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "RuntimeVersion": { "description": "A runtime version that a Node can be configured with.", "id": "RuntimeVersion", @@ -2155,6 +2219,22 @@ "description": "Defines whether the node is preemptible.", "type": "boolean" }, + "provisioningModel": { + "description": "Optional. Defines the provisioning model for the node.", + "enum": [ + "PROVISIONING_MODEL_UNSPECIFIED", + "STANDARD", + "SPOT", + "RESERVATION_BOUND" + ], + "enumDescriptions": [ + "Provisioning model is unknown.", + "Standard provisioning with user controlled runtime.", + "Spot provisioning with no guaranteed runtime.", + "Reservation provisioning with runtime bound to the lifetime of the consumed reservation." + ], + "type": "string" + }, "reserved": { "description": "Whether the node is created under a reservation.", "type": "boolean" diff --git a/discovery/trafficdirector-v3.json b/discovery/trafficdirector-v3.json index 11d8c37743d..40d5b78c5e4 100644 --- a/discovery/trafficdirector-v3.json +++ b/discovery/trafficdirector-v3.json @@ -128,7 +128,7 @@ } } }, - "revision": "20250206", + "revision": "20250423", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { @@ -1102,7 +1102,7 @@ "type": "object" }, "SocketAddress": { - "description": "[#next-free-field: 7]", + "description": "[#next-free-field: 8]", "id": "SocketAddress", "properties": { "address": { @@ -1117,6 +1117,10 @@ "description": "This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution.", "type": "string" }, + "networkNamespaceFilepath": { + "description": "The Linux network namespace to bind the socket to. If this is set, Envoy will create the socket in the specified network namespace. Only supported on Linux. [#not-implemented-hide:]", + "type": "string" + }, "portValue": { "format": "uint32", "type": "integer" diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index c52b9cff787..e1f654a1ab4 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -424,6 +424,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -1710,7 +1716,7 @@ } } }, - "revision": "20241218", + "revision": "20250424", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { diff --git a/discovery/translate-v3beta1.json b/discovery/translate-v3beta1.json index c50de444308..9a798a5530d 100644 --- a/discovery/translate-v3beta1.json +++ b/discovery/translate-v3beta1.json @@ -366,6 +366,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -747,7 +753,7 @@ } } }, - "revision": "20241218", + "revision": "20250424", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { diff --git a/discovery/vault-v1.json b/discovery/vault-v1.json index 24b8bfc9778..2cfea32af19 100644 --- a/discovery/vault-v1.json +++ b/discovery/vault-v1.json @@ -17,7 +17,7 @@ "canonicalName": "Vault", "description": "Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. ", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/vault", + "documentationLink": "https://developers.google.com/workspace/vault", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -258,7 +258,7 @@ "enumDescriptions": [ "The amount of detail is unspecified. Same as **BASIC**.", "Returns the matter ID, name, description, and state. Default choice.", - "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission))." + "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission))." ], "location": "query", "type": "string" @@ -318,7 +318,7 @@ "enumDescriptions": [ "The amount of detail is unspecified. Same as **BASIC**.", "Returns the matter ID, name, description, and state. Default choice.", - "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission))." + "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission))." ], "location": "query", "type": "string" @@ -1203,7 +1203,7 @@ } } }, - "revision": "20250212", + "revision": "20250331", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -1634,7 +1634,6 @@ "type": "string" }, "includeSharedDrives": { - "deprecated": true, "description": "Set to **true** to include shared drives.", "type": "boolean" }, @@ -1919,7 +1918,7 @@ "id": "HangoutsChatInfo", "properties": { "roomId": { - "description": "A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request.", + "description": "A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request.", "items": { "type": "string" }, @@ -2585,13 +2584,13 @@ ], "enumDescriptions": [ "A search method must be specified or else it is rejected.", - "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Query#accountinfo).", - "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Query#orgunitinfo).", + "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#accountinfo).", + "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#orgunitinfo).", "Search the data in the Team Drive specified in **team_drive_info**.", "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 messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#hangoutschatinfo).", + "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#sitesurlinfo).", + "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#shareddriveinfo).", "Retrieve the documents specified in DriveDocumentInfo." ], "type": "string" @@ -2627,13 +2626,13 @@ ], "enumDescriptions": [ "A search method must be specified or else it is rejected.", - "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Query#accountinfo).", - "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Query#orgunitinfo).", + "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#accountinfo).", + "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#orgunitinfo).", "Search the data in the Team Drive specified in **team_drive_info**.", "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 messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#hangoutschatinfo).", + "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#sitesurlinfo).", + "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#shareddriveinfo).", "Retrieve the documents specified in DriveDocumentInfo." ], "type": "string" diff --git a/discovery/verifiedaccess-v2.json b/discovery/verifiedaccess-v2.json index b708dc950be..fc18e39f030 100644 --- a/discovery/verifiedaccess-v2.json +++ b/discovery/verifiedaccess-v2.json @@ -146,7 +146,7 @@ } } }, - "revision": "20250225", + "revision": "20250318", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Antivirus": { @@ -468,7 +468,8 @@ "type": "array" }, "thirdPartyBlockingEnabled": { - "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.", + "deprecated": true, + "description": "Output only. Deprecated. The corresponding policy is now deprecated. 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" }, @@ -523,7 +524,7 @@ "type": "object" }, "VerifyChallengeResponseResult": { - "description": "Result message for VerifiedAccess.VerifyChallengeResponse.", + "description": "Result message for VerifiedAccess.VerifyChallengeResponse. The response returned when successful for Managed profiles on Unmanaged browsers will NOT have devicePermanentId, keyTrustLevel, virtualDeviceId and customerId fields. Managed profiles will INSTEAD have the profileCustomerId, virtualProfileId, profilePermanentId and profileKeyTrustLevel fields.", "id": "VerifyChallengeResponseResult", "properties": { "attestedDeviceId": { diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index 01b5fa324d8..7bebbbc13cb 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2220,7 +2226,7 @@ } } }, - "revision": "20250213", + "revision": "20250321", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4199,6 +4205,20 @@ "description": "Parameters affecting the OS adaptation process.", "id": "ImageImportOsAdaptationParameters", "properties": { + "bootConversion": { + "description": "Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion", + "enum": [ + "BOOT_CONVERSION_UNSPECIFIED", + "NONE", + "BIOS_TO_EFI" + ], + "enumDescriptions": [ + "Unspecified conversion type.", + "No conversion.", + "Convert from BIOS to EFI." + ], + "type": "string" + }, "generalize": { "description": "Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID).", "type": "boolean" diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index 0e0ea2d376a..d47e93e5bd6 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-v1alpha1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -2220,7 +2226,7 @@ } } }, - "revision": "20250213", + "revision": "20250321", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4234,6 +4240,20 @@ "description": "Parameters affecting the OS adaptation process.", "id": "ImageImportOsAdaptationParameters", "properties": { + "bootConversion": { + "description": "Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion", + "enum": [ + "BOOT_CONVERSION_UNSPECIFIED", + "NONE", + "BIOS_TO_EFI" + ], + "enumDescriptions": [ + "Unspecified conversion type.", + "No conversion.", + "Convert from BIOS to EFI." + ], + "type": "string" + }, "generalize": { "description": "Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID).", "type": "boolean" diff --git a/discovery/vmwareengine-v1.json b/discovery/vmwareengine-v1.json index c6cdddfb121..c829788d15e 100644 --- a/discovery/vmwareengine-v1.json +++ b/discovery/vmwareengine-v1.json @@ -168,6 +168,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -3362,7 +3368,7 @@ } } }, - "revision": "20250218", + "revision": "20250410", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "Announcement": { @@ -3647,6 +3653,14 @@ "description": "Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met.", "id": "Constraints", "properties": { + "disallowedIntervals": { + "description": "Output only. Output Only. A list of intervals in which maintenance windows are not allowed. Any time window that overlaps with any of these intervals will be considered invalid.", + "items": { + "$ref": "WeeklyTimeInterval" + }, + "readOnly": true, + "type": "array" + }, "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", @@ -6279,6 +6293,73 @@ } }, "type": "object" + }, + "WeeklyTimeInterval": { + "description": "Represents a time interval, spanning across days of the week. Until local timezones are supported, this interval is in UTC.", + "id": "WeeklyTimeInterval", + "properties": { + "endDay": { + "description": "Output only. The day on which the interval ends. Can be same as start day.", + "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" + ], + "readOnly": true, + "type": "string" + }, + "endTime": { + "$ref": "TimeOfDay", + "description": "Output only. The time on the end day at which the interval ends.", + "readOnly": true + }, + "startDay": { + "description": "Output only. The day on which the interval starts.", + "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" + ], + "readOnly": true, + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Output only. The time on the start day at which the interval starts.", + "readOnly": true + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/vpcaccess-v1.json b/discovery/vpcaccess-v1.json index 041aaa44845..dcc72522b03 100644 --- a/discovery/vpcaccess-v1.json +++ b/discovery/vpcaccess-v1.json @@ -118,6 +118,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -384,7 +390,7 @@ } } }, - "revision": "20240905", + "revision": "20250413", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { diff --git a/discovery/vpcaccess-v1beta1.json b/discovery/vpcaccess-v1beta1.json index 257ea036fce..24bbcc66277 100644 --- a/discovery/vpcaccess-v1beta1.json +++ b/discovery/vpcaccess-v1beta1.json @@ -118,6 +118,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -384,7 +390,7 @@ } } }, - "revision": "20240905", + "revision": "20250413", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { diff --git a/discovery/workflows-v1.json b/discovery/workflows-v1.json index 56c73897cd8..c165bae56f0 100644 --- a/discovery/workflows-v1.json +++ b/discovery/workflows-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -485,7 +491,7 @@ } } }, - "revision": "20250212", + "revision": "20250409", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/workflows-v1beta.json b/discovery/workflows-v1beta.json index 6201e2928e4..9c818c5a630 100644 --- a/discovery/workflows-v1beta.json +++ b/discovery/workflows-v1beta.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -444,7 +450,7 @@ } } }, - "revision": "20230802", + "revision": "20250409", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index bb705e230d3..0575d7d29dd 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -922,34 +928,9 @@ } } }, - "revision": "20250310", + "revision": "20250416", "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", @@ -968,74 +949,6 @@ }, "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", @@ -1134,26 +1047,6 @@ }, "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", @@ -1235,33 +1128,6 @@ }, "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", @@ -1304,7 +1170,7 @@ "type": "object" }, "Evaluation": { - "description": "LINT.IfChange Message describing Evaluation object", + "description": "Message describing Evaluation object", "id": "Evaluation", "properties": { "bigQueryDestination": { @@ -1574,31 +1440,6 @@ }, "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", @@ -2007,23 +1848,6 @@ }, "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", @@ -2830,6 +2654,13 @@ "description": "Disk mount on the instance.", "id": "SapDiscoveryResourceInstancePropertiesDiskMount", "properties": { + "diskNames": { + "description": "Optional. Names of the disks providing this mount point.", + "items": { + "type": "string" + }, + "type": "array" + }, "mountPoint": { "description": "Optional. Filesystem mount point.", "type": "string" @@ -3157,39 +2988,6 @@ }, "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", @@ -3242,33 +3040,6 @@ }, "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", @@ -3324,6 +3095,10 @@ "description": "Optional. Maintenance status", "type": "string" }, + "onHostMaintenance": { + "description": "Optional. Instance maintenance behavior. Could be \"MIGRATE\" or \"TERMINATE\".", + "type": "string" + }, "startTime": { "description": "Optional. Start time", "format": "google-datetime", @@ -3397,10 +3172,6 @@ "$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", @@ -3421,10 +3192,6 @@ "readOnly": true, "type": "string" }, - "threeTierWorkload": { - "$ref": "ThreeTierWorkload", - "description": "The 3 tier web app workload content" - }, "workloadType": { "description": "Required. The type of the workload", "enum": [ diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index e10219a967c..e2c27f262b7 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -197,7 +197,7 @@ "subscriptions": { "methods": { "create": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription).", + "description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). ", "flatPath": "v1/subscriptions", "httpMethod": "POST", "id": "workspaceevents.subscriptions.create", @@ -235,7 +235,7 @@ ] }, "delete": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription).", + "description": "Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription).", "flatPath": "v1/subscriptions/{subscriptionsId}", "httpMethod": "DELETE", "id": "workspaceevents.subscriptions.delete", @@ -290,7 +290,7 @@ ] }, "get": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Gets details about a Google Workspace subscription. To learn how to use this method, see [Get details about a Google Workspace subscription](https://developers.google.com/workspace/events/guides/get-subscription).", + "description": "Gets details about a Google Workspace subscription. To learn how to use this method, see [Get details about a Google Workspace subscription](https://developers.google.com/workspace/events/guides/get-subscription).", "flatPath": "v1/subscriptions/{subscriptionsId}", "httpMethod": "GET", "id": "workspaceevents.subscriptions.get", @@ -330,7 +330,7 @@ ] }, "list": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Lists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions).", + "description": "Lists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions).", "flatPath": "v1/subscriptions", "httpMethod": "GET", "id": "workspaceevents.subscriptions.list", @@ -377,7 +377,7 @@ ] }, "patch": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).", + "description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).", "flatPath": "v1/subscriptions/{subscriptionsId}", "httpMethod": "PATCH", "id": "workspaceevents.subscriptions.patch", @@ -430,7 +430,7 @@ ] }, "reactivate": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview): Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).", + "description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).", "flatPath": "v1/subscriptions/{subscriptionsId}:reactivate", "httpMethod": "POST", "id": "workspaceevents.subscriptions.reactivate", @@ -474,7 +474,7 @@ } } }, - "revision": "20250225", + "revision": "20250427", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { @@ -500,7 +500,7 @@ "id": "NotificationEndpoint", "properties": { "pubsubTopic": { - "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).", + "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. Note: The Workspace Events API uses [ordering keys](https://cloud.google.com/pubsub/docs/ordering) for the benefit of sequential events. If the Cloud Pub/Sub topic has a [message storage policy](https://cloud.google.com/pubsub/docs/resource-location-restriction#exceptions) configured to exclude the nearest Google Cloud region, publishing events with ordering keys will fail. 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" } }, @@ -591,7 +591,7 @@ "type": "object" }, "Subscription": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).", + "description": "A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).", "id": "Subscription", "properties": { "authority": { diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index 7b86048fa04..960f14bb4e6 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "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", @@ -414,6 +420,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filter the WorkstationClusters to be listed. Possible filters are described in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. Maximum number of items to return.", "format": "int32", @@ -632,6 +643,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filter the WorkstationConfigs to be listed. Possible filters are described in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. Maximum number of items to return.", "format": "int32", @@ -965,6 +981,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filter the Workstations to be listed. Possible filters are described in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. Maximum number of items to return.", "format": "int32", @@ -1195,7 +1216,7 @@ } } }, - "revision": "20250219", + "revision": "20250326", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1567,7 +1588,7 @@ "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. 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.", + "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, see [the filesystems available in Container-Optimized OS](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.", "type": "string" } }, @@ -1605,7 +1626,7 @@ "type": "integer" }, "sourceSnapshot": { - "description": "Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.", + "description": "Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. Must be formatted as ext4 file system with no partitions.", "type": "string" } }, @@ -2325,7 +2346,7 @@ "type": "string" }, "degraded": { - "description": "Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.", + "description": "Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster.", "readOnly": true, "type": "boolean" }, @@ -2379,7 +2400,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" }, "uid": { @@ -2415,7 +2436,7 @@ "type": "object" }, "conditions": { - "description": "Output only. Status conditions describing the current resource state.", + "description": "Output only. Status conditions describing the workstation configuration's current state.", "items": { "$ref": "Status" }, @@ -2433,7 +2454,7 @@ "type": "string" }, "degraded": { - "description": "Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.", + "description": "Output only. Whether this workstation configuration is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the configuration.", "readOnly": true, "type": "boolean" }, diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index f929a82517e..29859d763b1 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -346,6 +346,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filter the WorkstationClusters to be listed. Possible filters are described in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. Maximum number of items to return.", "format": "int32", @@ -564,6 +569,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filter the WorkstationConfigs to be listed. Possible filters are described in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. Maximum number of items to return.", "format": "int32", @@ -897,6 +907,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filter the Workstations to be listed. Possible filters are described in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. Maximum number of items to return.", "format": "int32", @@ -1127,7 +1142,7 @@ } } }, - "revision": "20250219", + "revision": "20250326", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1499,7 +1514,7 @@ "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. 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.", + "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, see [the filesystems available in Container-Optimized OS](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.", "type": "string" } }, @@ -1537,7 +1552,7 @@ "type": "integer" }, "sourceSnapshot": { - "description": "Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.", + "description": "Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. Must be formatted as ext4 file system with no partitions.", "type": "string" } }, @@ -2111,7 +2126,7 @@ "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.", + "description": "Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the workstation.", "readOnly": true, "type": "boolean" }, @@ -2263,7 +2278,7 @@ "type": "string" }, "degraded": { - "description": "Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.", + "description": "Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster.", "readOnly": true, "type": "boolean" }, @@ -2327,7 +2342,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" }, "uid": { @@ -2363,7 +2378,7 @@ "type": "object" }, "conditions": { - "description": "Output only. Status conditions describing the current resource state.", + "description": "Output only. Status conditions describing the workstation configuration's current state.", "items": { "$ref": "Status" }, @@ -2381,7 +2396,7 @@ "type": "string" }, "degraded": { - "description": "Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.", + "description": "Output only. Whether this workstation configuration is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the configuration.", "readOnly": true, "type": "boolean" }, diff --git a/discovery/youtube-v3.json b/discovery/youtube-v3.json index 5b09910eace..f433691f39e 100644 --- a/discovery/youtube-v3.json +++ b/discovery/youtube-v3.json @@ -185,6 +185,7 @@ "type": "integer" }, "mine": { + "deprecated": true, "location": "query", "type": "boolean" }, @@ -938,6 +939,11 @@ "required": true, "type": "string" }, + "postId": { + "description": "Returns the comment threads of the specified post.", + "location": "query", + "type": "string" + }, "searchTerms": { "description": "Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.", "location": "query", @@ -4100,7 +4106,7 @@ } } }, - "revision": "20250224", + "revision": "20250422", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -5763,7 +5769,7 @@ "type": "boolean" }, "channelId": { - "description": "The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.", + "description": "The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.", "type": "string" }, "likeCount": { @@ -5788,7 +5794,11 @@ "type": "string" }, "parentId": { - "description": "The unique id of the parent comment, only set for replies.", + "description": "The unique id of the top-level comment, only set for replies.", + "type": "string" + }, + "postId": { + "description": "The ID of the post the comment refers to, if any.", "type": "string" }, "publishedAt": { @@ -5831,10 +5841,11 @@ "type": "object" }, "CommentSnippetAuthorChannelId": { - "description": "The id of the author's YouTube channel, if any.", + "description": "Contains the id of the author's YouTube channel, if any.", "id": "CommentSnippetAuthorChannelId", "properties": { "value": { + "description": "The id of the author's YouTube channel.", "type": "string" } }, @@ -5935,13 +5946,17 @@ "type": "boolean" }, "channelId": { - "description": "The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.", + "description": "The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If neither video_id nor post_id is set the comments refer to the channel itself.", "type": "string" }, "isPublic": { "description": "Whether the thread (and therefore all its comments) is visible to all YouTube users.", "type": "boolean" }, + "postId": { + "description": "The ID of the post the comments refer to, if any.", + "type": "string" + }, "topLevelComment": { "$ref": "Comment", "description": "The top level comment of this thread." @@ -5952,7 +5967,7 @@ "type": "integer" }, "videoId": { - "description": "The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.", + "description": "The ID of the video the comments refer to, if any.", "type": "string" } }, diff --git a/release-please-config.json b/release-please-config.json index 39576cd4786..81ed6fd13b7 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -309,6 +309,8 @@ "src/apis/parallelstore": {}, "src/apis/securityposture": {}, "src/apis/areainsights": {}, - "src/apis/managedkafka": {} + "src/apis/managedkafka": {}, + "src/apis/observability": {}, + "src/apis/storagebatchoperations": {} } } \ No newline at end of file diff --git a/src/apis/accessapproval/v1.ts b/src/apis/accessapproval/v1.ts index 4966fa8f723..b38358e7c0c 100644 --- a/src/apis/accessapproval/v1.ts +++ b/src/apis/accessapproval/v1.ts @@ -153,6 +153,14 @@ export namespace accessapproval_v1 { * Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). */ ancestorHasActiveKeyVersion?: boolean | null; + /** + * Optional. Policy for approval. This contains all policies. + */ + approvalPolicy?: Schema$CustomerApprovalApprovalPolicy; + /** + * Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + */ + effectiveApprovalPolicy?: Schema$CustomerApprovalApprovalPolicy; /** * Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). */ @@ -295,6 +303,10 @@ export namespace accessapproval_v1 { * If set, denotes the timestamp at which the approval is invalidated. */ invalidateTime?: string | null; + /** + * True when the request has been approved by the customer's defined policy. + */ + policyApproved?: boolean | null; /** * The signature for the ApprovalRequest and details on how it was signed. */ @@ -309,6 +321,15 @@ export namespace accessapproval_v1 { */ command?: string | null; } + /** + * Represents all the policies that can be set for Customer Approval. + */ + export interface Schema$CustomerApprovalApprovalPolicy { + /** + * Optional. Policy for approval based on the justification given. + */ + justificationBasedApprovalPolicy?: string | null; + } /** * Request to dismiss an approval request. */ diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 609741eab3b..cdfe9e11d2c 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -4857,7 +4857,7 @@ export namespace accesscontextmanager_v1 { export interface Params$Resource$Organizations$Gcpuseraccessbindings$Patch extends StandardParameters { /** - * Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite. So far, only scoped_access_settings with reauth_settings supports appending. Global access_levels, access_levels in scoped_access_settings, dry_run_access_levels, reauth_settings, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when "scoped_access_settings" is not set in the update_mask. + * Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite. So far, only scoped_access_settings with session_settings supports appending. Global access_levels, access_levels in scoped_access_settings, dry_run_access_levels, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when "scoped_access_settings" is not set in the update_mask. */ append?: boolean; /** @@ -4865,7 +4865,7 @@ export namespace accesscontextmanager_v1 { */ name?: string; /** - * Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `reauth_settings` `session_settings`, `scoped_access_settings`. update_mask { paths: "access_levels" \} + * Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`, `session_settings`, `scoped_access_settings`. update_mask { paths: "access_levels" \} */ updateMask?: string; diff --git a/src/apis/addressvalidation/v1.ts b/src/apis/addressvalidation/v1.ts index c23e5db2969..e330f0ee818 100644 --- a/src/apis/addressvalidation/v1.ts +++ b/src/apis/addressvalidation/v1.ts @@ -150,7 +150,7 @@ export namespace addressvalidation_v1 { */ formattedAddress?: string | null; /** - * The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. Components of this type are not present in `formatted_address`, `postal_address`, or `address_components`. An example might be `['street_number', 'route']` for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + * The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. An example might be `['street_number', 'route']` for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). **Note: you might see a missing component type when you think you've already supplied the missing component.** For example, this can happen when the input address contains the building name, but not the premise number. In the address "渋谷区渋谷３丁目　Shibuya Stream", the building name "Shibuya Stream" has the component type `premise`, but the premise number is missing, so `missing_component_types` will contain `premise`. */ missingComponentTypes?: string[] | null; /** @@ -583,7 +583,7 @@ export namespace addressvalidation_v1 { */ hasUnconfirmedComponents?: boolean | null; /** - * The granularity of the **input** address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to `validation_granularity` below. For example, if the input address includes a specific apartment number, then the `input_granularity` here will be `SUB_PREMISE`. If we cannot match the apartment number in the databases or the apartment number is invalid, the `validation_granularity` will likely be `PREMISE` or below. + * The granularity of the **input** address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to `validation_granularity` below. For example, if the input address includes a specific apartment number, then the `input_granularity` here will be `SUB_PREMISE`. If we cannot match the apartment number in the databases or the apartment number is invalid, the `validation_granularity` will likely be `PREMISE` or worse. */ inputGranularity?: string | null; /** @@ -605,15 +605,15 @@ export namespace addressvalidation_v1 { longitude?: number | 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 + * 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 or 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -621,7 +621,7 @@ export namespace addressvalidation_v1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -629,7 +629,7 @@ export namespace addressvalidation_v1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -645,11 +645,11 @@ export namespace addressvalidation_v1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 5f4b5e52ea7..3b388557b8a 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -1776,7 +1776,7 @@ export namespace admin_directory_v1 { */ makeAndModel?: string | null; /** - * The resource name of the Printer object, in the format customers/{customer-id\}/printers/{printer-id\} (During printer creation leave empty) + * Identifier. The resource name of the Printer object, in the format customers/{customer-id\}/printers/{printer-id\} (During printer creation leave empty) */ name?: string | null; /** @@ -1830,7 +1830,7 @@ export namespace admin_directory_v1 { */ id?: string | null; /** - * Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id\}/printServers/{print_server.id\}` + * Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id\}/printServers/{print_server.id\}` */ name?: string | null; /** @@ -5485,7 +5485,7 @@ export namespace admin_directory_v1 { */ clearMask?: string; /** - * The resource name of the Printer object, in the format customers/{customer-id\}/printers/{printer-id\} (During printer creation leave empty) + * Identifier. The resource name of the Printer object, in the format customers/{customer-id\}/printers/{printer-id\} (During printer creation leave empty) */ name?: string; /** @@ -6225,7 +6225,7 @@ export namespace admin_directory_v1 { export interface Params$Resource$Customers$Chrome$Printservers$Patch extends StandardParameters { /** - * Immutable. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id\}/printServers/{print_server.id\}` + * Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id\}/printServers/{print_server.id\}` */ name?: string; /** diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index 0a165b710c4..35dc12bfbf1 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -163,6 +163,11 @@ export namespace admin_reports_v1 { * User doing the action. */ actor?: { + applicationInfo?: { + applicationName?: string; + impersonation?: boolean; + oauthClientId?: string; + }; callerType?: string; email?: string; key?: string; @@ -187,6 +192,7 @@ export namespace admin_reports_v1 { name?: string; value?: string; }>; + resourceIds?: string[]; type?: string; }> | null; /** @@ -210,6 +216,31 @@ export namespace admin_reports_v1 { * This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner. */ ownerDomain?: string | null; + /** + * Details of the resource on which the action was performed. + */ + resourceDetails?: Schema$ResourceDetails[]; + } + /** + * Details of the label applied on the resource. + */ + export interface Schema$AppliedLabel { + /** + * List of fields which are part of the label and have been set by the user. If label has a field which was not set by the user, it would not be present in this list. + */ + fieldValues?: Schema$FieldValue[]; + /** + * Identifier of the label - Only the label id, not the full OnePlatform resource name. + */ + id?: string | null; + /** + * The reason why the label was applied on the resource. + */ + reason?: Schema$Reason; + /** + * Title of the label + */ + title?: string | null; } /** * A notification channel used to watch for resource changes. @@ -256,6 +287,137 @@ export namespace admin_reports_v1 { */ type?: string | null; } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + 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; + } + /** + * Details of the field value set by the user for the particular label. + */ + export interface Schema$FieldValue { + /** + * Setting a date value. + */ + dateValue?: Schema$Date; + /** + * Display name of the field + */ + displayName?: string | null; + /** + * Identifier of the field + */ + id?: string | null; + /** + * Setting an integer value. + */ + integerValue?: string | null; + /** + * Setting a long text value. + */ + longTextValue?: string | null; + /** + * The reason why the field was applied to the label. + */ + reason?: Schema$Reason; + /** + * Setting a selection list value by selecting multiple values from a dropdown. + */ + selectionListValue?: Schema$FieldValueSelectionListValue; + /** + * Setting a selection value by selecting a single value from a dropdown. + */ + selectionValue?: Schema$FieldValueSelectionValue; + /** + * Setting a text list value. + */ + textListValue?: Schema$FieldValueTextListValue; + /** + * Setting a text value. + */ + textValue?: string | null; + /** + * Type of the field + */ + type?: string | null; + /** + * If the field is unset, this will be true. + */ + unsetValue?: boolean | null; + /** + * Setting a user list value by selecting multiple users. + */ + userListValue?: Schema$FieldValueUserListValue; + /** + * Setting a user value by selecting a single user. + */ + userValue?: Schema$FieldValueUserValue; + } + /** + * Setting a selection list value by selecting multiple values from a dropdown. + */ + export interface Schema$FieldValueSelectionListValue { + /** + * List of selections. + */ + values?: Schema$FieldValueSelectionValue[]; + } + /** + * Setting a selection value by selecting a single value from a dropdown. + */ + export interface Schema$FieldValueSelectionValue { + /** + * Whether the selection is badged. + */ + badged?: boolean | null; + /** + * Display name of the selection. + */ + displayName?: string | null; + /** + * Identifier of the selection. + */ + id?: string | null; + } + /** + * Setting a text list value. + */ + export interface Schema$FieldValueTextListValue { + /** + * List of text values. + */ + values?: string[] | null; + } + /** + * Setting a user list value by selecting multiple users. + */ + export interface Schema$FieldValueUserListValue { + /** + * List of users. + */ + values?: Schema$FieldValueUserValue[]; + } + /** + * Setting a user value by selecting a single user. + */ + export interface Schema$FieldValueUserValue { + /** + * Email of the user. + */ + email?: string | null; + } /** * JSON template for a parameter used in various reports. */ @@ -289,6 +451,40 @@ export namespace admin_reports_v1 { */ value?: string | null; } + /** + * The reason why the label/field was applied. + */ + export interface Schema$Reason { + /** + * The type of the reason. + */ + reasonType?: string | null; + } + /** + * Details of the resource on which the action was performed. + */ + export interface Schema$ResourceDetails { + /** + * List of labels applied on the resource + */ + appliedLabels?: Schema$AppliedLabel[]; + /** + * Identifier of the resource. + */ + id?: string | null; + /** + * Defines relationship of the resource to the events + */ + relation?: string | null; + /** + * Title of the resource. For instance, in case of a drive document, this would be the title of the document. In case of an email, this would be the subject. + */ + title?: string | null; + /** + * Type of the resource - document, email, chat message + */ + type?: string | null; + } /** * JSON template for a usage report. */ diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index b164177ee15..30a9053f4f4 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -112,6 +112,7 @@ export namespace aiplatform_v1 { */ export class Aiplatform { context: APIRequestContext; + batchPredictionJobs: Resource$Batchpredictionjobs; datasets: Resource$Datasets; endpoints: Resource$Endpoints; media: Resource$Media; @@ -124,6 +125,7 @@ export namespace aiplatform_v1 { google, }; + this.batchPredictionJobs = new Resource$Batchpredictionjobs(this.context); this.datasets = new Resource$Datasets(this.context); this.endpoints = new Resource$Endpoints(this.context); this.media = new Resource$Media(this.context); @@ -730,7 +732,7 @@ export namespace aiplatform_v1 { */ 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. + * Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. */ flipEnabled?: boolean | null; /** @@ -1808,6 +1810,26 @@ export namespace aiplatform_v1 { */ role?: string | null; } + /** + * Map of placeholder in metric prompt template to contents of model input. + */ + export interface Schema$GoogleCloudAiplatformV1ContentMap { + /** + * Optional. Map of placeholder to contents. + */ + values?: { + [key: string]: Schema$GoogleCloudAiplatformV1ContentMapContents; + } | null; + } + /** + * Repeated Content type. + */ + export interface Schema$GoogleCloudAiplatformV1ContentMapContents { + /** + * Optional. Repeated contents. + */ + contents?: Schema$GoogleCloudAiplatformV1Content[]; + } /** * Instance of a general context. */ @@ -2419,6 +2441,24 @@ export namespace aiplatform_v1 { */ workerPoolSpecs?: Schema$GoogleCloudAiplatformV1WorkerPoolSpec[]; } + /** + * Spec for custom output. + */ + export interface Schema$GoogleCloudAiplatformV1CustomOutput { + /** + * Output only. List of raw output strings. + */ + rawOutputs?: Schema$GoogleCloudAiplatformV1RawOutput; + } + /** + * Spec for custom output format configuration. + */ + export interface Schema$GoogleCloudAiplatformV1CustomOutputFormatConfig { + /** + * Optional. Whether to return raw output. + */ + returnRawOutput?: boolean | null; + } /** * A piece of data in a Dataset. Could be an image, a video, a document or plain text. */ @@ -3223,7 +3263,7 @@ export namespace aiplatform_v1 { */ createTime?: string | null; /** - * Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id\}.{region\}-{project_number\}.prediction.vertexai.goog`. + * Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: `https://{endpoint_id\}.{region\}-{uid\}.prediction.vertexai.goog`. */ dedicatedEndpointDns?: string | null; /** @@ -3459,7 +3499,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1EvaluateDatasetRequest { /** - * Optional. Autorater config used for evaluation. + * Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT\}/locations/{LOCATION\}/publishers/google/models/{MODEL\}.` */ autoraterConfig?: Schema$GoogleCloudAiplatformV1AutoraterConfig; /** @@ -3551,6 +3591,10 @@ export namespace aiplatform_v1 { * Instances and metric spec for rouge metric. */ rougeInput?: Schema$GoogleCloudAiplatformV1RougeInput; + /** + * Rubric Based Instruction Following metric. + */ + rubricBasedInstructionFollowingInput?: Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput; /** * Input for safety metric. */ @@ -3680,6 +3724,10 @@ export namespace aiplatform_v1 { * Results for rouge metric. */ rougeResults?: Schema$GoogleCloudAiplatformV1RougeResults; + /** + * Result for rubric based instruction following metric. + */ + rubricBasedInstructionFollowingResult?: Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult; /** * Result for safety metric. */ @@ -3746,7 +3794,7 @@ export namespace aiplatform_v1 { */ bigquerySource?: Schema$GoogleCloudAiplatformV1BigQuerySource; /** - * Cloud storage source holds the dataset. + * Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. */ gcsSource?: Schema$GoogleCloudAiplatformV1GcsSource; } @@ -4502,6 +4550,10 @@ export namespace aiplatform_v1 { * The fact used in grounding. */ export interface Schema$GoogleCloudAiplatformV1Fact { + /** + * If present, chunk properties. + */ + chunk?: Schema$GoogleCloudAiplatformV1RagChunk; /** * Query that is used to retrieve this fact. */ @@ -4613,6 +4665,14 @@ export namespace aiplatform_v1 { * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` */ name?: string | null; + /** + * Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup. + */ + serviceAccountEmail?: string | null; + /** + * Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table. + */ + serviceAgentType?: string | null; /** * Output only. Timestamp when this FeatureGroup was last updated. */ @@ -5621,7 +5681,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1FunctionCall { /** - * Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + * Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. */ args?: {[key: string]: any} | null; /** @@ -5690,7 +5750,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1GcsSource { /** - * Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. + * Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. */ uris?: string[] | null; } @@ -5839,6 +5899,10 @@ export namespace aiplatform_v1 { * Total token count for prompt, response candidates, and tool-use prompts (if present). */ totalTokenCount?: number | null; + /** + * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + */ + trafficType?: string | null; } /** * Generate video response. @@ -5946,6 +6010,10 @@ export namespace aiplatform_v1 { * 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$GoogleCloudAiplatformV1GenerationConfigThinkingConfig; /** * Optional. If specified, top-k sampling will be used. */ @@ -5982,10 +6050,19 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode { /** - * The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'. + * The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */ modelName?: string | null; } + /** + * Config for thinking features. + */ + export interface Schema$GoogleCloudAiplatformV1GenerationConfigThinkingConfig { + /** + * Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. + */ + thinkingBudget?: number | null; + } /** * Generic Metadata shared by all operations. */ @@ -6112,6 +6189,10 @@ export namespace aiplatform_v1 { * Chunk from context retrieved by the retrieval tools. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkRetrievedContext { + /** + * Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + */ + ragChunk?: Schema$GoogleCloudAiplatformV1RagChunk; /** * Text of the attribution. */ @@ -6129,6 +6210,10 @@ export namespace aiplatform_v1 { * Chunk from the web. */ export interface Schema$GoogleCloudAiplatformV1GroundingChunkWeb { + /** + * Domain of the (original) URI. + */ + domain?: string | null; /** * Title of the chunk. */ @@ -8902,10 +8987,6 @@ export namespace aiplatform_v1 { * 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. */ @@ -9584,6 +9665,23 @@ export namespace aiplatform_v1 { */ idleTimeout?: string | null; } + /** + * Notebook Reservation Affinity for consuming Zonal reservation. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookReservationAffinity { + /** + * Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples. + */ + consumeReservationType?: string | null; + /** + * Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value. + */ + key?: string | null; + /** + * Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation. + */ + values?: string[] | null; + } /** * A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours. */ @@ -9660,6 +9758,10 @@ export namespace aiplatform_v1 { * Output only. The proxy endpoint used to access the NotebookRuntime. */ proxyUri?: string | null; + /** + * Output only. Reservation Affinity of the notebook runtime. + */ + reservationAffinity?: Schema$GoogleCloudAiplatformV1NotebookReservationAffinity; /** * Output only. The runtime (instance) state of the NotebookRuntime. */ @@ -9761,6 +9863,10 @@ export namespace aiplatform_v1 { * Optional. Immutable. The type of the notebook runtime template. */ notebookRuntimeType?: string | null; + /** + * Optional. Reservation Affinity of the notebook runtime template. + */ + reservationAffinity?: Schema$GoogleCloudAiplatformV1NotebookReservationAffinity; /** * Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */ @@ -9826,6 +9932,10 @@ export namespace aiplatform_v1 { * Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. */ export interface Schema$GoogleCloudAiplatformV1PairwiseMetricInstance { + /** + * Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content. + */ + contentMapInstance?: Schema$GoogleCloudAiplatformV1ContentMap; /** * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. */ @@ -9835,6 +9945,10 @@ export namespace aiplatform_v1 { * Spec for pairwise metric result. */ export interface Schema$GoogleCloudAiplatformV1PairwiseMetricResult { + /** + * Output only. Spec for custom output. + */ + customOutput?: Schema$GoogleCloudAiplatformV1CustomOutput; /** * Output only. Explanation for pairwise metric score. */ @@ -9856,6 +9970,10 @@ export namespace aiplatform_v1 { * Optional. The field name of the candidate response. */ candidateResponseFieldName?: string | null; + /** + * Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + */ + customOutputFormatConfig?: Schema$GoogleCloudAiplatformV1CustomOutputFormatConfig; /** * Required. Metric prompt template for pairwise metric. */ @@ -10432,6 +10550,10 @@ export namespace aiplatform_v1 { * Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. */ export interface Schema$GoogleCloudAiplatformV1PointwiseMetricInstance { + /** + * Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content. + */ + contentMapInstance?: Schema$GoogleCloudAiplatformV1ContentMap; /** * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. */ @@ -10441,6 +10563,10 @@ export namespace aiplatform_v1 { * Spec for pointwise metric result. */ export interface Schema$GoogleCloudAiplatformV1PointwiseMetricResult { + /** + * Output only. Spec for custom output. + */ + customOutput?: Schema$GoogleCloudAiplatformV1CustomOutput; /** * Output only. Explanation for pointwise metric score. */ @@ -10454,6 +10580,10 @@ export namespace aiplatform_v1 { * Spec for pointwise metric. */ export interface Schema$GoogleCloudAiplatformV1PointwiseMetricSpec { + /** + * Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + */ + customOutputFormatConfig?: Schema$GoogleCloudAiplatformV1CustomOutputFormatConfig; /** * Required. Metric prompt template for pointwise metric. */ @@ -10706,7 +10836,7 @@ export namespace aiplatform_v1 { */ port?: number | null; /** - * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. + * Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC. */ service?: string | null; } @@ -11500,6 +11630,32 @@ export namespace aiplatform_v1 { */ version?: number | null; } + /** + * A RagChunk includes the content of a chunk of a RagFile, and associated metadata. + */ + export interface Schema$GoogleCloudAiplatformV1RagChunk { + /** + * If populated, represents where the chunk starts and ends in the document. + */ + pageSpan?: Schema$GoogleCloudAiplatformV1RagChunkPageSpan; + /** + * The content of the chunk. + */ + text?: string | null; + } + /** + * Represents where the chunk starts and ends in the document. + */ + export interface Schema$GoogleCloudAiplatformV1RagChunkPageSpan { + /** + * Page where chunk starts in the document. Inclusive. 1-indexed. + */ + firstPage?: number | null; + /** + * Page where chunk ends in the document. Inclusive. 1-indexed. + */ + lastPage?: number | null; + } /** * Relevant contexts for one query. */ @@ -11513,6 +11669,10 @@ export namespace aiplatform_v1 { * A context of the query. */ export interface Schema$GoogleCloudAiplatformV1RagContextsContext { + /** + * Context of the retrieved chunk. + */ + chunk?: Schema$GoogleCloudAiplatformV1RagChunk; /** * According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant. */ @@ -11562,6 +11722,10 @@ export namespace aiplatform_v1 { * Optional. Immutable. The config for the Vector DBs. */ vectorDbConfig?: Schema$GoogleCloudAiplatformV1RagVectorDbConfig; + /** + * Optional. Immutable. The config for the Vertex AI Search. + */ + vertexAiSearchConfig?: Schema$GoogleCloudAiplatformV1VertexAiSearchConfig; } /** * Config for the embedding model to use for RAG. @@ -11716,6 +11880,10 @@ export namespace aiplatform_v1 { * Optional. Config for filters. */ filter?: Schema$GoogleCloudAiplatformV1RagRetrievalConfigFilter; + /** + * Optional. Config for ranking and reranking. + */ + ranking?: Schema$GoogleCloudAiplatformV1RagRetrievalConfigRanking; /** * Optional. The number of contexts to retrieve. */ @@ -11738,6 +11906,37 @@ export namespace aiplatform_v1 { */ vectorSimilarityThreshold?: number | null; } + /** + * Config for ranking and reranking. + */ + export interface Schema$GoogleCloudAiplatformV1RagRetrievalConfigRanking { + /** + * Optional. Config for LlmRanker. + */ + llmRanker?: Schema$GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker; + /** + * Optional. Config for Rank Service. + */ + rankService?: Schema$GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService; + } + /** + * Config for LlmRanker. + */ + export interface Schema$GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker { + /** + * Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + */ + modelName?: string | null; + } + /** + * Config for Rank Service. + */ + export interface Schema$GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService { + /** + * Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + */ + modelName?: string | null; + } /** * Config for the Vector DB to use for RAG. */ @@ -11789,6 +11988,15 @@ export namespace aiplatform_v1 { */ indexEndpoint?: string | null; } + /** + * Raw output. + */ + export interface Schema$GoogleCloudAiplatformV1RawOutput { + /** + * Output only. Raw output string. + */ + rawOutput?: string[] | null; + } /** * Request message for PredictionService.RawPredict. */ @@ -12024,7 +12232,7 @@ export namespace aiplatform_v1 { */ name?: string | null; /** - * Required. Configurations of the ReasoningEngine + * Optional. Configurations of the ReasoningEngine */ spec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpec; /** @@ -12037,7 +12245,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpec { /** - * Optional. The OSS agent framework used to develop the agent. Currently supported values: "langchain", "langgraph", "ag2", "custom". + * Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". */ agentFramework?: string | null; /** @@ -12049,7 +12257,7 @@ export namespace aiplatform_v1 { */ deploymentSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec; /** - * Required. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + * Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. */ packageSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec; } @@ -12411,6 +12619,58 @@ export namespace aiplatform_v1 { */ useStemmer?: boolean | null; } + /** + * Instance and metric spec for RubricBasedInstructionFollowing metric. + */ + export interface Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput { + /** + * Required. Instance for RubricBasedInstructionFollowing metric. + */ + instance?: Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance; + /** + * Required. Spec for RubricBasedInstructionFollowing metric. + */ + metricSpec?: Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec; + } + /** + * Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset. + */ + export interface Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance { + /** + * Required. Instance specified as a json string. String key-value pairs are expected in the json_instance to render RubricBasedInstructionFollowing prompt templates. + */ + jsonInstance?: string | null; + } + /** + * Result for RubricBasedInstructionFollowing metric. + */ + export interface Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult { + /** + * Output only. List of per rubric critique results. + */ + rubricCritiqueResults?: Schema$GoogleCloudAiplatformV1RubricCritiqueResult[]; + /** + * Output only. Overall score for the instruction following. + */ + score?: number | null; + } + /** + * Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score. + */ + export interface Schema$GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec {} + /** + * Rubric critique result. + */ + export interface Schema$GoogleCloudAiplatformV1RubricCritiqueResult { + /** + * Output only. Rubric to be evaluated. + */ + rubric?: string | null; + /** + * Output only. Verdict for the rubric - true if the rubric is met, false otherwise. + */ + verdict?: boolean | null; + } /** * Input for safety metric. */ @@ -15835,7 +16095,7 @@ export namespace aiplatform_v1 { */ 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. + * Required. The name of the secret in Cloud Secret Manager. Format: {secret_name\}. */ secret?: string | null; /** @@ -16060,6 +16320,10 @@ export namespace aiplatform_v1 { * The speech generation config. */ export interface Schema$GoogleCloudAiplatformV1SpeechConfig { + /** + * Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + */ + languageCode?: string | null; /** * The configuration for the speaker to use. */ @@ -18081,7 +18345,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1TuningJob { /** - * The base model that is being tuned, e.g., "gemini-1.0-pro-002". . + * The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */ baseModel?: string | null; /** @@ -18515,6 +18779,15 @@ export namespace aiplatform_v1 { */ engine?: string | null; } + /** + * Config for the Vertex AI Search. + */ + export interface Schema$GoogleCloudAiplatformV1VertexAiSearchConfig { + /** + * Vertex AI Search Serving Config resource full name. For example, `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config\}` or `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config\}`. + */ + servingConfig?: string | null; + } /** * Retrieve from Vertex RAG Store for grounding. */ @@ -18927,18 +19200,14 @@ export namespace aiplatform_v1 { units?: string | null; } - export class Resource$Datasets { + export class Resource$Batchpredictionjobs { context: APIRequestContext; - datasetVersions: Resource$Datasets$Datasetversions; constructor(context: APIRequestContext) { this.context = context; - this.datasetVersions = new Resource$Datasets$Datasetversions( - this.context - ); } /** - * Creates a Dataset. + * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18946,55 +19215,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Datasets$Create, + params: Params$Resource$Batchpredictionjobs$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Datasets$Create, + params?: Params$Resource$Batchpredictionjobs$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Datasets$Create, + params: Params$Resource$Batchpredictionjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Datasets$Create, + params: Params$Resource$Batchpredictionjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Datasets$Create, - callback: BodyResponseCallback + params: Params$Resource$Batchpredictionjobs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Datasets$Create - | BodyResponseCallback + | Params$Resource$Batchpredictionjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Create; + let params = (paramsOrCallback || + {}) as Params$Resource$Batchpredictionjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Create; + params = {} as Params$Resource$Batchpredictionjobs$Create; options = {}; } @@ -19007,7 +19277,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/datasets').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/batchPredictionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -19019,108 +19292,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a Dataset. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Datasets$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Datasets$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Datasets$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Datasets$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Datasets$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Datasets$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + return createAPIRequest( + parameters ); - } else { - return createAPIRequest(parameters); } } /** - * Gets a Dataset. + * Gets a BatchPredictionJob * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19128,55 +19312,482 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Datasets$Get, + params: Params$Resource$Batchpredictionjobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Datasets$Get, + params?: Params$Resource$Batchpredictionjobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Datasets$Get, + params: Params$Resource$Batchpredictionjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Datasets$Get, + params: Params$Resource$Batchpredictionjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Datasets$Get, - callback: BodyResponseCallback + params: Params$Resource$Batchpredictionjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Datasets$Get - | BodyResponseCallback + | Params$Resource$Batchpredictionjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Batchpredictionjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Get; + params = {} as Params$Resource$Batchpredictionjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists BatchPredictionJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Batchpredictionjobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Batchpredictionjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Batchpredictionjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Batchpredictionjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Batchpredictionjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Batchpredictionjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Batchpredictionjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Batchpredictionjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/batchPredictionJobs').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$Batchpredictionjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchPredictionJob; + } + export interface Params$Resource$Batchpredictionjobs$Get + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; + } + export interface Params$Resource$Batchpredictionjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Datasets { + context: APIRequestContext; + datasetVersions: Resource$Datasets$Datasetversions; + constructor(context: APIRequestContext) { + this.context = context; + this.datasetVersions = new Resource$Datasets$Datasetversions( + this.context + ); + } + + /** + * Creates a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datasets$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Datasets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Datasets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Datasets$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Datasets$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Datasets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Datasets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/datasets').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datasets$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Datasets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Datasets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Datasets$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Datasets$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Datasets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Datasets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datasets$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Datasets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Datasets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Datasets$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Datasets$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Datasets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Datasets$Get; options = {}; } @@ -20125,8 +20736,10 @@ export namespace aiplatform_v1 { export class Resource$Endpoints { context: APIRequestContext; + chat: Resource$Endpoints$Chat; constructor(context: APIRequestContext) { this.context = context; + this.chat = new Resource$Endpoints$Chat(this.context); } /** @@ -20676,6 +21289,117 @@ export namespace aiplatform_v1 { requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; } + export class Resource$Endpoints$Chat { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Exposes an OpenAI-compatible endpoint for chat completions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completions( + params: Params$Resource$Endpoints$Chat$Completions, + options: StreamMethodOptions + ): GaxiosPromise; + completions( + params?: Params$Resource$Endpoints$Chat$Completions, + options?: MethodOptions + ): GaxiosPromise; + completions( + params: Params$Resource$Endpoints$Chat$Completions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Endpoints$Chat$Completions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Endpoints$Chat$Completions, + callback: BodyResponseCallback + ): void; + completions(callback: BodyResponseCallback): void; + completions( + paramsOrCallback?: + | Params$Resource$Endpoints$Chat$Completions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Endpoints$Chat$Completions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Endpoints$Chat$Completions; + 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}/chat/completions').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); + } + } + } + + export interface Params$Resource$Endpoints$Chat$Completions + 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$GoogleApiHttpBody; + } + export class Resource$Media { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -21053,6 +21777,7 @@ export namespace aiplatform_v1 { pipelineJobs: Resource$Projects$Locations$Pipelinejobs; publishers: Resource$Projects$Locations$Publishers; ragCorpora: Resource$Projects$Locations$Ragcorpora; + ragEngineConfig: Resource$Projects$Locations$Ragengineconfig; reasoningEngines: Resource$Projects$Locations$Reasoningengines; schedules: Resource$Projects$Locations$Schedules; specialistPools: Resource$Projects$Locations$Specialistpools; @@ -21123,6 +21848,9 @@ export namespace aiplatform_v1 { this.ragCorpora = new Resource$Projects$Locations$Ragcorpora( this.context ); + this.ragEngineConfig = new Resource$Projects$Locations$Ragengineconfig( + this.context + ); this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( this.context ); @@ -21871,6 +22599,10 @@ export namespace aiplatform_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -26841,7 +27573,7 @@ export namespace aiplatform_v1 { } /** - * Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights. + * Lists Annotations belongs to a dataitem. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -34452,6 +35184,100 @@ export namespace aiplatform_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$Featuregroups$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists FeatureGroups in a given project and location. * @@ -34640,6 +35466,198 @@ export namespace aiplatform_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$Featuregroups$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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$Featuregroups$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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$Featuregroups$Create @@ -34676,6 +35694,17 @@ export namespace aiplatform_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$List extends StandardParameters { /** @@ -34715,6 +35744,29 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; } + export interface Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$Testiampermissions + extends StandardParameters { + /** + * 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[]; + /** + * 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; + } export class Resource$Projects$Locations$Featuregroups$Features { context: APIRequestContext; @@ -69119,17 +70171,533 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a RagFile. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$Ragfiles$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Import files from Google Cloud Storage or Google Drive into a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$Ragfiles$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/ragFiles:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists RagFiles in a RagCorpus. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$Ragfiles$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/ragFiles').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$Ragcorpora$Ragfiles$Delete + extends StandardParameters { + /** + * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + extends StandardParameters { + /** + * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + extends StandardParameters { + /** + * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportRagFilesRequest; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + extends StandardParameters { + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + */ + pageToken?: string; + /** + * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Ragcorpora$Ragfiles$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$Ragcorpora$Ragfiles$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + 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}: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$Ragcorpora$Ragfiles$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a RagFile. + * 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`. @@ -69137,57 +70705,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$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$Ragcorpora$Ragfiles$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; options = {}; } @@ -69212,77 +70780,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Import files from Google Cloud Storage or Google Drive into a RagCorpus. + * 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. */ - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$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$Ragcorpora$Ragfiles$Import; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; options = {}; } @@ -69295,90 +70861,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragFiles:import').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists RagFiles in a RagCorpus. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$Ragfiles$List, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + wait( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; options = {}; } @@ -69391,76 +70959,93 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragFiles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { /** - * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { /** - * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { /** - * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportRagFilesRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { /** - * Optional. The standard list page size. + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + * The standard list page token. */ pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + extends StandardParameters { /** - * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * The name of the operation resource to wait on. */ - parent?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { + export class Resource$Projects$Locations$Ragengineconfig { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragengineconfig$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Ragengineconfig$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Ragengineconfig$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -69475,31 +71060,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69515,13 +71100,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; options = {}; } @@ -69564,31 +71149,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69604,13 +71189,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; options = {}; } @@ -69653,27 +71238,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -69681,7 +71266,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69697,13 +71282,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; options = {}; } @@ -69746,27 +71331,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, callback: BodyResponseCallback ): void; list( @@ -69774,7 +71359,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69790,13 +71375,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; options = {}; } @@ -69844,27 +71429,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -69872,7 +71457,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69888,13 +71473,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; options = {}; } @@ -69929,28 +71514,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$List extends StandardParameters { /** * The standard list filter. @@ -69969,7 +71554,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -70667,6 +72252,10 @@ export namespace aiplatform_v1 { } export interface Params$Resource$Projects$Locations$Reasoningengines$Delete extends StandardParameters { + /** + * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + */ + force?: boolean; /** * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index d2ee6c98d3b..1878aa58e10 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -112,6 +112,7 @@ export namespace aiplatform_v1beta1 { */ export class Aiplatform { context: APIRequestContext; + batchPredictionJobs: Resource$Batchpredictionjobs; datasets: Resource$Datasets; endpoints: Resource$Endpoints; media: Resource$Media; @@ -124,6 +125,7 @@ export namespace aiplatform_v1beta1 { google, }; + this.batchPredictionJobs = new Resource$Batchpredictionjobs(this.context); this.datasets = new Resource$Datasets(this.context); this.endpoints = new Resource$Endpoints(this.context); this.media = new Resource$Media(this.context); @@ -396,6 +398,15 @@ export namespace aiplatform_v1beta1 { */ extensions?: Array<{[key: string]: any}> | null; } + /** + * Request message for ModelGardenService.AcceptPublisherModelEula. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest { + /** + * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}`, or `publishers/hf-{hugging-face-author\}/models/{hugging-face-model-name\}` + */ + publisherModel?: string | null; + } /** * Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy. */ @@ -549,6 +560,10 @@ export namespace aiplatform_v1beta1 { */ apiKeySecretVersion?: string | null; } + /** + * Response message for SessionService.AppendEvent. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AppendEventResponse {} /** * Instance of a general artifact. */ @@ -627,19 +642,43 @@ export namespace aiplatform_v1beta1 { * Request message for DatasetService.AssembleData. Used only for MULTIMODAL datasets. */ export interface Schema$GoogleCloudAiplatformV1beta1AssembleDataRequest { + /** + * Optional. The read config for the dataset. + */ + geminiRequestReadConfig?: Schema$GoogleCloudAiplatformV1beta1GeminiRequestReadConfig; /** * Optional. Config for assembling templates with a Gemini API structure. */ geminiTemplateConfig?: Schema$GoogleCloudAiplatformV1beta1GeminiTemplateConfig; + /** + * Optional. The column name in the underlying table that contains already fully assembled requests. If this field is set, the original request will be copied to the output table. + */ + requestColumnName?: string | null; } /** * Request message for DatasetService.AssessData. Used only for MULTIMODAL datasets. */ export interface Schema$GoogleCloudAiplatformV1beta1AssessDataRequest { + /** + * Optional. Configuration for the batch prediction resource usage assessment. + */ + batchPredictionResourceUsageAssessmentConfig?: Schema$GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig; + /** + * Optional. Configuration for the batch prediction validation assessment. + */ + batchPredictionValidationAssessmentConfig?: Schema$GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig; + /** + * Optional. The Gemini request read config for the dataset. + */ + geminiRequestReadConfig?: Schema$GoogleCloudAiplatformV1beta1GeminiRequestReadConfig; /** * Optional. Config for assembling templates with a Gemini API structure to assess assembled data. */ geminiTemplateConfig?: Schema$GoogleCloudAiplatformV1beta1GeminiTemplateConfig; + /** + * Optional. The column name in the underlying table that contains already fully assembled requests. + */ + requestColumnName?: string | null; /** * Optional. Configuration for the tuning resource usage assessment. */ @@ -649,6 +688,24 @@ export namespace aiplatform_v1beta1 { */ tuningValidationAssessmentConfig?: Schema$GoogleCloudAiplatformV1beta1AssessDataRequestTuningValidationAssessmentConfig; } + /** + * Configuration for the batch prediction resource usage assessment. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig { + /** + * Required. The name of the model used for batch prediction. + */ + modelName?: string | null; + } + /** + * Configuration for the batch prediction validation assessment. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig { + /** + * Required. The name of the model used for batch prediction. + */ + modelName?: string | null; + } /** * Configuration for the tuning resource usage assessment. */ @@ -893,7 +950,7 @@ export namespace aiplatform_v1beta1 { */ 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. + * Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. */ flipEnabled?: boolean | null; /** @@ -1679,6 +1736,15 @@ export namespace aiplatform_v1beta1 { */ safetyRatings?: Schema$GoogleCloudAiplatformV1beta1SafetyRating[]; } + /** + * Request message for ModelGardenService.CheckPublisherModelEula. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest { + /** + * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}`, or `publishers/hf-{hugging-face-author\}/models/{hugging-face-model-name\}` + */ + publisherModel?: string | null; + } /** * This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request. */ @@ -2001,6 +2067,48 @@ export namespace aiplatform_v1beta1 { */ role?: string | null; } + /** + * Map of placeholder in metric prompt template to contents of model input. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ContentMap { + /** + * Optional. Map of placeholder to contents. + */ + values?: { + [key: string]: Schema$GoogleCloudAiplatformV1beta1ContentMapContents; + } | null; + } + /** + * Repeated Content type. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ContentMapContents { + /** + * Optional. Repeated contents. + */ + contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + } + /** + * A single example of a conversation with the model. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ContentsExample { + /** + * Required. The content of the conversation with the model that resulted in the expected output. + */ + contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output. + */ + expectedContents?: Schema$GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent[]; + } + /** + * A single step of the expected output. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent { + /** + * Required. A single step's content. + */ + content?: Schema$GoogleCloudAiplatformV1beta1Content; + } /** * Instance of a general context. */ @@ -2660,6 +2768,24 @@ export namespace aiplatform_v1beta1 { */ workerPoolSpecs?: Schema$GoogleCloudAiplatformV1beta1WorkerPoolSpec[]; } + /** + * Spec for custom output. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CustomOutput { + /** + * Output only. List of raw output strings. + */ + rawOutputs?: Schema$GoogleCloudAiplatformV1beta1RawOutput; + } + /** + * Spec for custom output format configuration. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CustomOutputFormatConfig { + /** + * Optional. Whether to return raw output. + */ + returnRawOutput?: boolean | null; + } /** * A piece of data in a Dataset. Could be an image, a video, a document or plain text. */ @@ -3506,6 +3632,10 @@ export namespace aiplatform_v1beta1 { * Optional. If true, enable the QMT fast tryout feature for this model if possible. */ fastTryoutEnabled?: boolean | null; + /** + * Optional. System labels for Model Garden deployments. These labels are managed by Google and for tracking purposes only. + */ + systemLabels?: {[key: string]: string} | null; } /** * The endpoint config to use for the deployment. @@ -3660,7 +3790,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1DistillationSpec { /** - * The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002". + * The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */ baseTeacherModel?: string | null; /** @@ -3732,7 +3862,7 @@ export namespace aiplatform_v1beta1 { */ createTime?: string | null; /** - * Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id\}.{region\}-{project_number\}.prediction.vertexai.goog`. + * Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: `https://{endpoint_id\}.{region\}-{uid\}.prediction.vertexai.goog`. */ dedicatedEndpointDns?: string | null; /** @@ -3968,7 +4098,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1EvaluateDatasetRequest { /** - * Optional. Autorater config used for evaluation. + * Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT\}/locations/{LOCATION\}/publishers/google/models/{MODEL\}.` */ autoraterConfig?: Schema$GoogleCloudAiplatformV1beta1AutoraterConfig; /** @@ -4060,6 +4190,10 @@ export namespace aiplatform_v1beta1 { * Instances and metric spec for rouge metric. */ rougeInput?: Schema$GoogleCloudAiplatformV1beta1RougeInput; + /** + * Rubric Based Instruction Following metric. + */ + rubricBasedInstructionFollowingInput?: Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput; /** * Input for safety metric. */ @@ -4189,6 +4323,10 @@ export namespace aiplatform_v1beta1 { * Results for rouge metric. */ rougeResults?: Schema$GoogleCloudAiplatformV1beta1RougeResults; + /** + * Result for rubric based instruction following metric. + */ + rubricBasedInstructionFollowingResult?: Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult; /** * Result for safety metric. */ @@ -4255,7 +4393,7 @@ export namespace aiplatform_v1beta1 { */ bigquerySource?: Schema$GoogleCloudAiplatformV1beta1BigQuerySource; /** - * Cloud storage source holds the dataset. + * Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. */ gcsSource?: Schema$GoogleCloudAiplatformV1beta1GcsSource; } @@ -4284,6 +4422,68 @@ export namespace aiplatform_v1beta1 { */ type?: string | null; } + /** + * Actions are parts of events that are executed by the agent. + */ + export interface Schema$GoogleCloudAiplatformV1beta1EventActions { + /** + * Optional. Indicates that the event is updating an artifact. key is the filename, value is the version. + */ + artifactDelta?: {[key: string]: number} | null; + /** + * Optional. The agent is escalating to a higher level agent. + */ + escalate?: boolean | null; + /** + * Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct. + */ + requestedAuthConfigs?: {[key: string]: any} | null; + /** + * Optional. If true, it won't call model to summarize function response. Only used for function_response event. + */ + skipSummarization?: boolean | null; + /** + * Optional. Indicates that the event is updating the state with the given delta. + */ + stateDelta?: {[key: string]: any} | null; + /** + * Optional. If set, the event transfers to the specified agent. + */ + transferAgent?: string | null; + /** + * Deprecated. If set, the event transfers to the specified agent. + */ + transferToAgent?: boolean | null; + } + /** + * Metadata relating to a LLM response event. + */ + export interface Schema$GoogleCloudAiplatformV1beta1EventMetadata { + /** + * Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history. + */ + branch?: string | null; + /** + * Optional. Metadata returned to client when grounding is enabled. + */ + groundingMetadata?: Schema$GoogleCloudAiplatformV1beta1GroundingMetadata; + /** + * Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. + */ + interrupted?: boolean | null; + /** + * Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. + */ + longRunningToolIds?: string[] | null; + /** + * Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. + */ + partial?: boolean | null; + /** + * Optional. Indicates whether the response from the model is complete. Only used for streaming mode. + */ + turnComplete?: boolean | null; + } /** * Input for exact match metric. */ @@ -4332,6 +4532,27 @@ export namespace aiplatform_v1beta1 { * Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. */ export interface Schema$GoogleCloudAiplatformV1beta1ExactMatchSpec {} + /** + * A single example to upload or read from the Example Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Example { + /** + * Output only. Timestamp when this Example was created. + */ + createTime?: string | null; + /** + * Optional. The display name for Example. + */ + displayName?: string | null; + /** + * Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated. + */ + exampleId?: string | null; + /** + * An example of chat history and its expected outcome to be used with GenerateContent. + */ + storedContentsExample?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExample; + } /** * Example-based explainability that returns the nearest neighbors from the provided dataset. */ @@ -4357,6 +4578,19 @@ export namespace aiplatform_v1beta1 { */ presets?: Schema$GoogleCloudAiplatformV1beta1Presets; } + /** + * Filters for examples' array metadata fields. An array field is example metadata where multiple values are attributed to a single example. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExamplesArrayFilter { + /** + * Required. The operator logic to use for filtering. + */ + arrayOperator?: string | null; + /** + * Required. The values by which to filter examples. + */ + values?: string[] | null; + } /** * The Cloud Storage input instances. */ @@ -4412,6 +4646,44 @@ export namespace aiplatform_v1beta1 { */ namespaceName?: string | null; } + /** + * Represents an executable service to manage and retrieve examples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExampleStore { + /** + * Output only. Timestamp when this ExampleStore was created. + */ + createTime?: string | null; + /** + * Optional. Description of the ExampleStore. + */ + description?: string | null; + /** + * Required. Display name of the ExampleStore. + */ + displayName?: string | null; + /** + * Required. Example Store config. + */ + exampleStoreConfig?: Schema$GoogleCloudAiplatformV1beta1ExampleStoreConfig; + /** + * Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project\}/locations/{location\}/exampleStores/{example_store\} + */ + name?: string | null; + /** + * Output only. Timestamp when this ExampleStore was most recently updated. + */ + updateTime?: string | null; + } + /** + * Configuration for the Example Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExampleStoreConfig { + /** + * Required. The embedding model to be used for vector embedding. Immutable. Supported models: * "text-embedding-005" * "text-multilingual-embedding-002" + */ + vertexEmbeddingModel?: 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]. */ @@ -4998,6 +5270,15 @@ export namespace aiplatform_v1beta1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } + /** + * Request message for ModelGardenService.ExportPublisherModel. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExportPublisherModelRequest { + /** + * Required. The target where we are exporting the model weights to + */ + destination?: Schema$GoogleCloudAiplatformV1beta1GcsDestination; + } /** * Response message for ModelGardenService.ExportPublisherModel. */ @@ -5162,6 +5443,10 @@ export namespace aiplatform_v1beta1 { * The fact used in grounding. */ export interface Schema$GoogleCloudAiplatformV1beta1Fact { + /** + * If present, chunk properties. + */ + chunk?: Schema$GoogleCloudAiplatformV1beta1RagChunk; /** * Query that is used to retrieve this fact. */ @@ -5995,6 +6280,80 @@ export namespace aiplatform_v1beta1 { */ parts?: string[] | null; } + /** + * Request message for FeatureOnlineStoreService.FeatureViewDirectWrite. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest { + /** + * Required. The data keys and associated feature values. + */ + dataKeyAndFeatureValues?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues[]; + } + /** + * A data key and associated feature values to write to the feature view. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues { + /** + * The data key. + */ + dataKey?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDataKey; + /** + * List of features to write. + */ + features?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature[]; + } + /** + * Feature name & value pair. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature { + /** + * Feature short name. + */ + name?: string | null; + /** + * Feature value and timestamp. + */ + valueAndTimestamp?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp; + } + /** + * Feature value and timestamp. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp { + /** + * The feature timestamp to store with this value. If not set, then the Feature Store server will generate a timestamp when it receives the write request. + */ + timestamp?: string | null; + /** + * The feature value. + */ + value?: Schema$GoogleCloudAiplatformV1beta1FeatureValue; + } + /** + * Response message for FeatureOnlineStoreService.FeatureViewDirectWrite. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse { + /** + * Response status for the keys listed in FeatureViewDirectWriteResponse.write_responses. The error only applies to the listed data keys - the stream will remain open for further FeatureOnlineStoreService.FeatureViewDirectWriteRequest requests. Partial failures (e.g. if the first 10 keys of a request fail, but the rest succeed) from a single request may result in multiple responses - there will be one response for the successful request keys and one response for the failing request keys. + */ + status?: Schema$GoogleRpcStatus; + /** + * Details about write for each key. If status is not OK, WriteResponse.data_key will have the key with error, but WriteResponse.online_store_write_time will not be present. + */ + writeResponses?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse[]; + } + /** + * Details about the write for each key. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse { + /** + * What key is this write response associated with. + */ + dataKey?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDataKey; + /** + * When the feature values were written to the online store. If FeatureViewDirectWriteResponse.status is not OK, this field is not populated. + */ + onlineStoreWriteTime?: string | null; + } /** * A Feature Registry source for features that need to be synced to Online Store. */ @@ -6192,6 +6551,40 @@ export namespace aiplatform_v1beta1 { */ uri?: string | null; } + /** + * Request message for ExampleStoreService.FetchExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FetchExamplesRequest { + /** + * Optional. Example IDs to fetch. If both metadata filters and Example IDs are specified, then both ID and metadata filtering will be applied. + */ + exampleIds?: string[] | null; + /** + * Optional. The maximum number of examples to return. The service may return fewer than this value. If unspecified, at most 100 examples will be returned. + */ + pageSize?: number | null; + /** + * Optional. The next_page_token value returned from a previous list ExampleStoreService.FetchExamplesResponse call. + */ + pageToken?: string | null; + /** + * The metadata filters for StoredContentsExamples. + */ + storedContentsExampleFilter?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleFilter; + } + /** + * Response message for ExampleStoreService.FetchExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FetchExamplesResponse { + /** + * The examples in the Example Store that satisfy the metadata filters. + */ + examples?: Schema$GoogleCloudAiplatformV1beta1Example[]; + /** + * A token, which can be sent as FetchExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned. */ @@ -6524,9 +6917,13 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1FunctionCall { /** - * Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + * Optional. 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]. */ @@ -6570,6 +6967,10 @@ export namespace aiplatform_v1beta1 { * 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]. */ @@ -6593,7 +6994,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1GcsSource { /** - * Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. + * Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. */ uris?: string[] | null; } @@ -6638,12 +7039,25 @@ export namespace aiplatform_v1beta1 { */ tools?: Schema$GoogleCloudAiplatformV1beta1Tool[]; } + /** + * Configuration for how to read Gemini requests from a multimodal dataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GeminiRequestReadConfig { + /** + * Optional. Column name in the dataset table that contains already fully assembled Gemini requests. + */ + assembledRequestColumnName?: string | null; + /** + * Gemini request template with placeholders. + */ + templateConfig?: Schema$GoogleCloudAiplatformV1beta1GeminiTemplateConfig; + } /** * Template configuration to create Gemini examples from a multimodal dataset. */ export interface Schema$GoogleCloudAiplatformV1beta1GeminiTemplateConfig { /** - * Required. Map of template params to the columns in the dataset table. + * Required. Map of template parameters to the columns in the dataset table. */ fieldMapping?: {[key: string]: string} | null; /** @@ -6826,6 +7240,10 @@ export namespace aiplatform_v1beta1 { * Total token count for prompt, response candidates, and tool-use prompts (if present). */ totalTokenCount?: number | null; + /** + * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + */ + trafficType?: string | null; } /** * Generate video response. @@ -6893,6 +7311,10 @@ export namespace aiplatform_v1beta1 { * Optional. If specified, the media resolution specified will be used. */ mediaResolution?: string | null; + /** + * Optional. Config for model selection. + */ + modelConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigModelConfig; /** * Optional. Positive penalties. */ @@ -6933,6 +7355,10 @@ export namespace aiplatform_v1beta1 { * 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. */ @@ -6942,6 +7368,15 @@ export namespace aiplatform_v1beta1 { */ topP?: number | null; } + /** + * Config for model selection. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigModelConfig { + /** + * Required. Feature selection preference. + */ + featureSelectionPreference?: string | null; + } /** * The configuration for routing the request to a specific model. */ @@ -6969,10 +7404,19 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode { /** - * The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'. + * The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */ modelName?: string | null; } + /** + * Config for thinking features. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig { + /** + * Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. + */ + thinkingBudget?: number | null; + } /** * Generic Metadata shared by all operations. */ @@ -7099,6 +7543,10 @@ export namespace aiplatform_v1beta1 { * Chunk from context retrieved by the retrieval tools. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext { + /** + * Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + */ + ragChunk?: Schema$GoogleCloudAiplatformV1beta1RagChunk; /** * Text of the attribution. */ @@ -7116,6 +7564,10 @@ export namespace aiplatform_v1beta1 { * Chunk from the web. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb { + /** + * Domain of the (original) URI. + */ + domain?: string | null; /** * Title of the chunk. */ @@ -7429,6 +7881,10 @@ export namespace aiplatform_v1beta1 { * Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/my_file.txt` - `gs://bucket_name/my_directory` */ gcsSource?: Schema$GoogleCloudAiplatformV1beta1GcsSource; + /** + * Optional. The max number of queries per minute that the indexing pipeline job is allowed to make to the embedding model specified in the project. Please follow the quota usage guideline of the embedding model you use to set the value properly.If this value is not specified, max_embedding_requests_per_min will be used by indexing pipeline job as the global limit. + */ + globalMaxEmbeddingRequestsPerMin?: number | null; /** * Google Drive location. Supports importing individual files as well as Google Drive folders. */ @@ -8069,6 +8525,32 @@ export namespace aiplatform_v1beta1 { */ nextPageToken?: string | null; } + /** + * Response message for SessionService.ListEvents. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListEventsResponse { + /** + * A token, which can be sent as ListEventsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of events matching the request. Ordered by timestamp in ascending order. + */ + sessionEvents?: Schema$GoogleCloudAiplatformV1beta1SessionEvent[]; + } + /** + * Response message for ExampleStoreService.ListExampleStores. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListExampleStoresResponse { + /** + * List of ExampleStore in the requested page. + */ + exampleStores?: Schema$GoogleCloudAiplatformV1beta1ExampleStore[]; + /** + * A token to retrieve the next page of results. Pass to ListExampleStoresRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + } /** * Response message for MetadataService.ListExecutions. */ @@ -8547,6 +9029,19 @@ export namespace aiplatform_v1beta1 { */ schedules?: Schema$GoogleCloudAiplatformV1beta1Schedule[]; } + /** + * Response message for SessionService.ListSessions. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListSessionsResponse { + /** + * A token, which can be sent as ListSessionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of sessions matching the request. + */ + sessions?: Schema$GoogleCloudAiplatformV1beta1Session[]; + } /** * Response message for SpecialistPoolService.ListSpecialistPools. */ @@ -10002,7 +10497,7 @@ export namespace aiplatform_v1beta1 { */ format?: string | null; /** - * Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. + * Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. */ gcsUri?: string | null; } @@ -10603,10 +11098,6 @@ export namespace aiplatform_v1beta1 { * 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. */ @@ -11285,6 +11776,23 @@ export namespace aiplatform_v1beta1 { */ idleTimeout?: string | null; } + /** + * Notebook Reservation Affinity for consuming Zonal reservation. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NotebookReservationAffinity { + /** + * Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples. + */ + consumeReservationType?: string | null; + /** + * Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value. + */ + key?: string | null; + /** + * Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation. + */ + values?: string[] | null; + } /** * A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours. */ @@ -11361,6 +11869,10 @@ export namespace aiplatform_v1beta1 { * Output only. The proxy endpoint used to access the NotebookRuntime. */ proxyUri?: string | null; + /** + * Output only. Reservation Affinity of the notebook runtime. + */ + reservationAffinity?: Schema$GoogleCloudAiplatformV1beta1NotebookReservationAffinity; /** * Output only. The runtime (instance) state of the NotebookRuntime. */ @@ -11462,6 +11974,10 @@ export namespace aiplatform_v1beta1 { * Optional. Immutable. The type of the notebook runtime template. */ notebookRuntimeType?: string | null; + /** + * Optional. Reservation Affinity of the notebook runtime template. + */ + reservationAffinity?: Schema$GoogleCloudAiplatformV1beta1NotebookReservationAffinity; /** * Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */ @@ -11527,6 +12043,10 @@ export namespace aiplatform_v1beta1 { * Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. */ export interface Schema$GoogleCloudAiplatformV1beta1PairwiseMetricInstance { + /** + * Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content. + */ + contentMapInstance?: Schema$GoogleCloudAiplatformV1beta1ContentMap; /** * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. */ @@ -11536,6 +12056,10 @@ export namespace aiplatform_v1beta1 { * Spec for pairwise metric result. */ export interface Schema$GoogleCloudAiplatformV1beta1PairwiseMetricResult { + /** + * Output only. Spec for custom output. + */ + customOutput?: Schema$GoogleCloudAiplatformV1beta1CustomOutput; /** * Output only. Explanation for pairwise metric score. */ @@ -11557,6 +12081,10 @@ export namespace aiplatform_v1beta1 { * Optional. The field name of the candidate response. */ candidateResponseFieldName?: string | null; + /** + * Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + */ + customOutputFormatConfig?: Schema$GoogleCloudAiplatformV1beta1CustomOutputFormatConfig; /** * Required. Metric prompt template for pairwise metric. */ @@ -12261,6 +12789,10 @@ export namespace aiplatform_v1beta1 { * Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. */ export interface Schema$GoogleCloudAiplatformV1beta1PointwiseMetricInstance { + /** + * Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content. + */ + contentMapInstance?: Schema$GoogleCloudAiplatformV1beta1ContentMap; /** * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. */ @@ -12270,6 +12802,10 @@ export namespace aiplatform_v1beta1 { * Spec for pointwise metric result. */ export interface Schema$GoogleCloudAiplatformV1beta1PointwiseMetricResult { + /** + * Output only. Spec for custom output. + */ + customOutput?: Schema$GoogleCloudAiplatformV1beta1CustomOutput; /** * Output only. Explanation for pointwise metric score. */ @@ -12283,6 +12819,10 @@ export namespace aiplatform_v1beta1 { * Spec for pointwise metric. */ export interface Schema$GoogleCloudAiplatformV1beta1PointwiseMetricSpec { + /** + * Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + */ + customOutputFormatConfig?: Schema$GoogleCloudAiplatformV1beta1CustomOutputFormatConfig; /** * Required. Metric prompt template for pointwise metric. */ @@ -12387,6 +12927,14 @@ export namespace aiplatform_v1beta1 { * If logging is enabled or not. */ enabled?: boolean | null; + /** + * This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false. + */ + enableOtelLogging?: boolean | null; + /** + * Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1". + */ + requestResponseLoggingSchemaVersion?: string | null; /** * Percentage of requests to be logged, expressed as a fraction in range(0,1]. */ @@ -12552,7 +13100,7 @@ export namespace aiplatform_v1beta1 { */ port?: number | null; /** - * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. + * Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC. */ service?: string | null; } @@ -12892,6 +13440,15 @@ export namespace aiplatform_v1beta1 { */ title?: string | null; } + /** + * This message contains configs of a publisher model. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PublisherModelConfig { + /** + * The prediction request/response logging config. + */ + loggingConfig?: Schema$GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig; + } /** * A named piece of documentation. */ @@ -12905,6 +13462,23 @@ export namespace aiplatform_v1beta1 { */ title?: string | null; } + /** + * Response message for ModelGardenService.UpdatePublisherModelEula. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance { + /** + * The project number requesting access for named model. + */ + projectNumber?: string | null; + /** + * The publisher model resource name. + */ + publisherModel?: string | null; + /** + * The EULA content acceptance status. + */ + publisherModelEulaAcked?: boolean | null; + } /** * The information about the parent of a model. */ @@ -13394,6 +13968,32 @@ export namespace aiplatform_v1beta1 { */ version?: number | null; } + /** + * A RagChunk includes the content of a chunk of a RagFile, and associated metadata. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagChunk { + /** + * If populated, represents where the chunk starts and ends in the document. + */ + pageSpan?: Schema$GoogleCloudAiplatformV1beta1RagChunkPageSpan; + /** + * The content of the chunk. + */ + text?: string | null; + } + /** + * Represents where the chunk starts and ends in the document. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagChunkPageSpan { + /** + * Page where chunk starts in the document. Inclusive. 1-indexed. + */ + firstPage?: number | null; + /** + * Page where chunk ends in the document. Inclusive. 1-indexed. + */ + lastPage?: number | null; + } /** * Relevant contexts for one query. */ @@ -13407,6 +14007,10 @@ export namespace aiplatform_v1beta1 { * A context of the query. */ export interface Schema$GoogleCloudAiplatformV1beta1RagContextsContext { + /** + * Context of the retrieved chunk. + */ + chunk?: Schema$GoogleCloudAiplatformV1beta1RagChunk; /** * The distance between the query dense embedding vector and the context text vector. */ @@ -13550,6 +14154,19 @@ export namespace aiplatform_v1beta1 { */ modelVersionId?: string | null; } + /** + * Config for RagEngine. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagEngineConfig { + /** + * Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + */ + name?: string | null; + /** + * The config of the RagManagedDb used by RagEngine. + */ + ragManagedDbConfig?: Schema$GoogleCloudAiplatformV1beta1RagManagedDbConfig; + } /** * A RagFile contains user data for chunking, embedding and indexing. */ @@ -13675,6 +14292,10 @@ export namespace aiplatform_v1beta1 { * Document AI Layout Parser config. */ export interface Schema$GoogleCloudAiplatformV1beta1RagFileParsingConfigLayoutParser { + /** + * The maximum number of requests the job is allowed to make to the Document AI processor per minute in this project. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline as the global limit. + */ + globalMaxParsingRequestsPerMin?: number | null; /** * 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. */ @@ -13692,6 +14313,10 @@ export namespace aiplatform_v1beta1 { * The prompt to use for parsing. If not specified, a default prompt will be used. */ customParsingPrompt?: string | null; + /** + * The maximum number of requests the job is allowed to make to the LLM model per minute in this project. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline job as the global limit. + */ + globalMaxParsingRequestsPerMin?: number | null; /** * The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used. */ @@ -13710,6 +14335,27 @@ export namespace aiplatform_v1beta1 { */ ragFileChunkingConfig?: Schema$GoogleCloudAiplatformV1beta1RagFileChunkingConfig; } + /** + * Configuration message for RagManagedDb used by RagEngine. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagManagedDbConfig { + /** + * Sets the RagManagedDb to the Basic tier. + */ + basic?: Schema$GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic; + /** + * Sets the RagManagedDb to the Enterprise tier. This is the default tier if not explicitly chosen. + */ + enterprise?: Schema$GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise; + } + /** + * Basic tier is a cost-effective and low compute tier suitable for the following cases: * Experimenting with RagManagedDb. * Small data size. * Latency insensitive workload. * Only using RAG Engine with external vector DBs. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic {} + /** + * Enterprise tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. NOTE: This is the default tier if not explicitly chosen. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise {} /** * A query to retrieve relevant contexts. */ @@ -13805,7 +14451,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker { /** - * Optional. The model name used for ranking. Format: `gemini-1.5-pro` + * Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */ modelName?: string | null; } @@ -13899,6 +14545,15 @@ export namespace aiplatform_v1beta1 { */ httpEndpoint?: string | null; } + /** + * Raw output. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RawOutput { + /** + * Output only. Raw output string. + */ + rawOutput?: string[] | null; + } /** * Request message for PredictionService.RawPredict. */ @@ -14138,7 +14793,7 @@ export namespace aiplatform_v1beta1 { */ name?: string | null; /** - * Required. Configurations of the ReasoningEngine + * Optional. Configurations of the ReasoningEngine */ spec?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngineSpec; /** @@ -14151,7 +14806,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1ReasoningEngineSpec { /** - * Optional. The OSS agent framework used to develop the agent. Currently supported values: "langchain", "langgraph", "ag2", "custom". + * Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". */ agentFramework?: string | null; /** @@ -14163,7 +14818,7 @@ export namespace aiplatform_v1beta1 { */ deploymentSpec?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec; /** - * Required. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. + * Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. */ packageSpec?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec; } @@ -14265,6 +14920,28 @@ export namespace aiplatform_v1beta1 { * Response message for IndexService.RemoveDatapoints */ export interface Schema$GoogleCloudAiplatformV1beta1RemoveDatapointsResponse {} + /** + * Request message for ExampleStoreService.RemoveExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RemoveExamplesRequest { + /** + * Optional. Example IDs to remove. If both metadata filters and Example IDs are specified, the metadata filters will be applied to the specified examples in order to identify which should be removed. + */ + exampleIds?: string[] | null; + /** + * The metadata filters for StoredContentsExamples. + */ + storedContentsExampleFilter?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleFilter; + } + /** + * Response message for ExampleStoreService.RemoveExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RemoveExamplesResponse { + /** + * The IDs for the removed examples. + */ + exampleIds?: string[] | null; + } /** * Request message for NotebookInternalService.ReportExecutionEvent. */ @@ -14617,6 +15294,58 @@ export namespace aiplatform_v1beta1 { */ useStemmer?: boolean | null; } + /** + * Instance and metric spec for RubricBasedInstructionFollowing metric. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput { + /** + * Required. Instance for RubricBasedInstructionFollowing metric. + */ + instance?: Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance; + /** + * Required. Spec for RubricBasedInstructionFollowing metric. + */ + metricSpec?: Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec; + } + /** + * Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance { + /** + * Required. Instance specified as a json string. String key-value pairs are expected in the json_instance to render RubricBasedInstructionFollowing prompt templates. + */ + jsonInstance?: string | null; + } + /** + * Result for RubricBasedInstructionFollowing metric. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult { + /** + * Output only. List of per rubric critique results. + */ + rubricCritiqueResults?: Schema$GoogleCloudAiplatformV1beta1RubricCritiqueResult[]; + /** + * Output only. Overall score for the instruction following. + */ + score?: number | null; + } + /** + * Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec {} + /** + * Rubric critique result. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RubricCritiqueResult { + /** + * Output only. Rubric to be evaluated. + */ + rubric?: string | null; + /** + * Output only. Verdict for the rubric - true if the rubric is met, false otherwise. + */ + verdict?: boolean | null; + } /** * The definition of a runtime artifact. */ @@ -17987,6 +18716,41 @@ export namespace aiplatform_v1beta1 { */ sdkBlob?: string | null; } + /** + * Request message for ExampleStoreService.SearchExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SearchExamplesRequest { + /** + * The parameters of StoredContentsExamples to be searched. + */ + storedContentsExampleParameters?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleParameters; + /** + * Optional. The number of similar examples to return. + */ + topK?: string | null; + } + /** + * Response message for ExampleStoreService.SearchExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SearchExamplesResponse { + /** + * The results of searching for similar examples. + */ + results?: Schema$GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample[]; + } + /** + * The result of the similar example. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample { + /** + * The example that is similar to the searched query. + */ + example?: Schema$GoogleCloudAiplatformV1beta1Example; + /** + * The similarity score of this example. + */ + similarityScore?: number | null; + } /** * Response message for FeaturestoreService.SearchFeatures. */ @@ -18240,7 +19004,7 @@ export namespace aiplatform_v1beta1 { */ 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. + * Required. The name of the secret in Cloud Secret Manager. Format: {secret_name\}. */ secret?: string | null; /** @@ -18282,6 +19046,85 @@ export namespace aiplatform_v1beta1 { */ serviceAccount?: string | null; } + /** + * A session contains a set of actions between users and Vertex agents. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Session { + /** + * Output only. Timestamp when the session was created. + */ + createTime?: string | null; + /** + * Optional. The display name of the session. + */ + displayName?: string | null; + /** + * Required. Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. + */ + name?: string | null; + /** + * Optional. Session specific memory which stores key conversation points. + */ + sessionState?: {[key: string]: any} | null; + /** + * Output only. Timestamp when the session was updated. + */ + updateTime?: string | null; + /** + * Required. Immutable. String id provided by the user + */ + userId?: string | null; + } + /** + * An event represents a message from either the user or agent. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SessionEvent { + /** + * Optional. Actions executed by the agent. + */ + actions?: Schema$GoogleCloudAiplatformV1beta1EventActions; + /** + * Required. The name of the agent that sent the event, or user. + */ + author?: string | null; + /** + * Optional. Content of the event provided by the author. + */ + content?: Schema$GoogleCloudAiplatformV1beta1Content; + /** + * Optional. Error code if the response is an error. Code varies by model. + */ + errorCode?: string | null; + /** + * Optional. Error message if the response is an error. + */ + errorMessage?: string | null; + /** + * Optional. Metadata relating to this event. + */ + eventMetadata?: Schema$GoogleCloudAiplatformV1beta1EventMetadata; + /** + * Required. The invocation id of the event, multiple events can have the same invocation id. + */ + invocationId?: string | null; + /** + * Required. Identifier. The resource name of the event. Format:`projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}/events/{event\}`. + */ + name?: string | null; + /** + * Required. Timestamp when the event was created on client side. + */ + timestamp?: string | null; + } + /** + * Request message for EndpointService.SetPublisherModelConfig. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest { + /** + * Required. The publisher model config. + */ + publisherModelConfig?: Schema$GoogleCloudAiplatformV1beta1PublisherModelConfig; + } /** * The SharePointSources to pass to ImportRagFiles. */ @@ -18465,6 +19308,10 @@ export namespace aiplatform_v1beta1 { * The speech generation config. */ export interface Schema$GoogleCloudAiplatformV1beta1SpeechConfig { + /** + * Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + */ + languageCode?: string | null; /** * The configuration for the speaker to use. */ @@ -18495,6 +19342,79 @@ export namespace aiplatform_v1beta1 { * Request message for VizierService.StopTrial. */ export interface Schema$GoogleCloudAiplatformV1beta1StopTrialRequest {} + /** + * A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1StoredContentsExample { + /** + * Required. The example to be used with GenerateContent. + */ + contentsExample?: Schema$GoogleCloudAiplatformV1beta1ContentsExample; + /** + * Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from `contents_example.contents` using the method provided by `search_key_generation_method`. The generated search key will be included in retrieved examples. + */ + searchKey?: string | null; + /** + * Optional. The method used to generate the search key from `contents_example.contents`. This is ignored when uploading an example if `search_key` is provided. + */ + searchKeyGenerationMethod?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod; + } + /** + * The metadata filters that will be used to remove or fetch StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied. + */ + export interface Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleFilter { + /** + * Optional. The function names for filtering. + */ + functionNames?: Schema$GoogleCloudAiplatformV1beta1ExamplesArrayFilter; + /** + * Optional. The search keys for filtering. Only examples with one of the specified search keys (StoredContentsExample.search_key) are eligible to be returned. + */ + searchKeys?: string[] | null; + } + /** + * The metadata filters that will be used to search StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied + */ + export interface Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleParameters { + /** + * The chat history to use to generate the search key for retrieval. + */ + contentSearchKey?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey; + /** + * Optional. The function names for filtering. + */ + functionNames?: Schema$GoogleCloudAiplatformV1beta1ExamplesArrayFilter; + /** + * The exact search key to use for retrieval. + */ + searchKey?: string | null; + } + /** + * The chat history to use to generate the search key for retrieval. + */ + export interface Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey { + /** + * Required. The conversation for generating a search key. + */ + contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Required. The method of generating a search key. + */ + searchKeyGenerationMethod?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod; + } + /** + * Options for generating the search key from the conversation history. + */ + export interface Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod { + /** + * Use only the last entry of the conversation history (`contents_example.contents`) as the search key. + */ + lastEntry?: Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry; + } + /** + * Configuration for using only the last entry of the conversation history as the search key. + */ + export interface Schema$GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry {} /** * Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the `key` field) is mirrored within each split. The fraction values determine the relative sizes of the splits. For example, if the specified column has three values, with 50% of the rows having value "A", 25% value "B", and 25% value "C", and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value "A" for the specified column, about 25% having the value "B", and about 25% having the value "C". Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned. Supported only for tabular Datasets. */ @@ -20605,7 +21525,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1TuningJob { /** - * The base model that is being tuned, e.g., "gemini-1.0-pro-002". . + * The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */ baseModel?: string | null; /** @@ -21026,6 +21946,41 @@ export namespace aiplatform_v1beta1 { * Response message for IndexService.UpsertDatapoints */ export interface Schema$GoogleCloudAiplatformV1beta1UpsertDatapointsResponse {} + /** + * Request message for ExampleStoreService.UpsertExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UpsertExamplesRequest { + /** + * Required. A list of examples to be created/updated. + */ + examples?: Schema$GoogleCloudAiplatformV1beta1Example[]; + /** + * Optional. A flag indicating whether an example can be overwritten if it already exists. If False (default) and the example already exists, the example will not be updated. This does not affect behavior if the example does not exist already. + */ + overwrite?: boolean | null; + } + /** + * Response message for ExampleStoreService.UpsertExamples. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UpsertExamplesResponse { + /** + * A list of results for creating/updating. It's either a successfully created/updated example or a status with an error message. + */ + results?: Schema$GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult[]; + } + /** + * The result for creating/updating a single example. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult { + /** + * The example created/updated successfully. + */ + example?: Schema$GoogleCloudAiplatformV1beta1Example; + /** + * The error message of the example that was not created/updated successfully. + */ + status?: Schema$GoogleRpcStatus; + } /** * References an API call. It contains more information about long running operation and Jobs that are triggered by the API call. */ @@ -21525,6 +22480,344 @@ export namespace aiplatform_v1beta1 { units?: string | null; } + export class Resource$Batchpredictionjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Batchpredictionjobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Batchpredictionjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Batchpredictionjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Batchpredictionjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Batchpredictionjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Batchpredictionjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Batchpredictionjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Batchpredictionjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/batchPredictionJobs').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 BatchPredictionJob + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Batchpredictionjobs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Batchpredictionjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Batchpredictionjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Batchpredictionjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Batchpredictionjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Batchpredictionjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Batchpredictionjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Batchpredictionjobs$Get; + 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: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists BatchPredictionJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Batchpredictionjobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Batchpredictionjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Batchpredictionjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Batchpredictionjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Batchpredictionjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Batchpredictionjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Batchpredictionjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Batchpredictionjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/batchPredictionJobs').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$Batchpredictionjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchPredictionJob; + } + export interface Params$Resource$Batchpredictionjobs$Get + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; + } + export interface Params$Resource$Batchpredictionjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export class Resource$Datasets { context: APIRequestContext; datasetVersions: Resource$Datasets$Datasetversions; @@ -22723,8 +24016,10 @@ export namespace aiplatform_v1beta1 { export class Resource$Endpoints { context: APIRequestContext; + chat: Resource$Endpoints$Chat; constructor(context: APIRequestContext) { this.context = context; + this.chat = new Resource$Endpoints$Chat(this.context); } /** @@ -23274,6 +24569,117 @@ export namespace aiplatform_v1beta1 { requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; } + export class Resource$Endpoints$Chat { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Exposes an OpenAI-compatible endpoint for chat completions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completions( + params: Params$Resource$Endpoints$Chat$Completions, + options: StreamMethodOptions + ): GaxiosPromise; + completions( + params?: Params$Resource$Endpoints$Chat$Completions, + options?: MethodOptions + ): GaxiosPromise; + completions( + params: Params$Resource$Endpoints$Chat$Completions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Endpoints$Chat$Completions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Endpoints$Chat$Completions, + callback: BodyResponseCallback + ): void; + completions(callback: BodyResponseCallback): void; + completions( + paramsOrCallback?: + | Params$Resource$Endpoints$Chat$Completions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Endpoints$Chat$Completions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Endpoints$Chat$Completions; + 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}/chat/completions').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); + } + } + } + + export interface Params$Resource$Endpoints$Chat$Completions + 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$GoogleApiHttpBody; + } + export class Resource$Media { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -23410,9 +24816,13 @@ export namespace aiplatform_v1beta1 { export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; + modelGardenEula: Resource$Projects$Modelgardeneula; constructor(context: APIRequestContext) { this.context = context; this.locations = new Resource$Projects$Locations(this.context); + this.modelGardenEula = new Resource$Projects$Modelgardeneula( + this.context + ); } /** @@ -23658,6 +25068,7 @@ export namespace aiplatform_v1beta1 { pipelineJobs: Resource$Projects$Locations$Pipelinejobs; publishers: Resource$Projects$Locations$Publishers; ragCorpora: Resource$Projects$Locations$Ragcorpora; + ragEngineConfig: Resource$Projects$Locations$Ragengineconfig; reasoningEngines: Resource$Projects$Locations$Reasoningengines; schedules: Resource$Projects$Locations$Schedules; solvers: Resource$Projects$Locations$Solvers; @@ -23748,6 +25159,9 @@ export namespace aiplatform_v1beta1 { this.ragCorpora = new Resource$Projects$Locations$Ragcorpora( this.context ); + this.ragEngineConfig = new Resource$Projects$Locations$Ragengineconfig( + this.context + ); this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( this.context ); @@ -24434,6 +25848,100 @@ export namespace aiplatform_v1beta1 { } } + /** + * Gets a RagEngineConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getRagEngineConfig( + params?: Params$Resource$Projects$Locations$Getragengineconfig, + options?: MethodOptions + ): GaxiosPromise; + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, + callback: BodyResponseCallback + ): void; + getRagEngineConfig( + callback: BodyResponseCallback + ): void; + getRagEngineConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getragengineconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getragengineconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getragengineconfig; + 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: '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. * @@ -24627,6 +26135,98 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * Updates a RagEngineConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateRagEngineConfig( + params?: Params$Resource$Projects$Locations$Updateragengineconfig, + options?: MethodOptions + ): GaxiosPromise; + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, + callback: BodyResponseCallback + ): void; + updateRagEngineConfig( + callback: BodyResponseCallback + ): void; + updateRagEngineConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updateragengineconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updateragengineconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updateragengineconfig; + 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$Augmentprompt @@ -24708,8 +26308,19 @@ export namespace aiplatform_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Getragengineconfig + extends StandardParameters { + /** + * Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -24739,6 +26350,18 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequest; } + export interface Params$Resource$Projects$Locations$Updateragengineconfig + extends StandardParameters { + /** + * Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RagEngineConfig; + } export class Resource$Projects$Locations$Agents { context: APIRequestContext; @@ -30999,7 +32622,7 @@ export namespace aiplatform_v1beta1 { } /** - * Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights. + * Lists Annotations belongs to a dataitem. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -39653,70 +41276,66 @@ export namespace aiplatform_v1beta1 { this.operations = new Resource$Projects$Locations$Examplestores$Operations(this.context); } - } - - export class Resource$Projects$Locations$Examplestores$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`. + * Create an ExampleStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Examplestores$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Examplestores$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Examplestores$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Examplestores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Examplestores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Examplestores$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Examplestores$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$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$Examplestores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Examplestores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Examplestores$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Examplestores$Create; options = {}; } @@ -39729,7 +41348,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/exampleStores:create').replace( /([^:]\/)\/+/g, '$1' ), @@ -39739,22 +41358,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Delete an ExampleStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -39762,124 +41381,35 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Examplestores$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, + params?: Params$Resource$Projects$Locations$Examplestores$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Examplestores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Examplestores$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Examplestores$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Examplestores$Operations$Delete; - 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: '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$Examplestores$Operations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Examplestores$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Get, + params: Params$Resource$Projects$Locations$Examplestores$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Examplestores$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Examplestores$Operations$Get + | Params$Resource$Projects$Locations$Examplestores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39895,13 +41425,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Examplestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Examplestores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Examplestores$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Examplestores$Delete; options = {}; } @@ -39915,7 +41444,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -39936,65 +41465,65 @@ export namespace aiplatform_v1beta1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Get Examples from the Example 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. */ - list( - params: Params$Resource$Projects$Locations$Examplestores$Operations$List, + fetchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Fetchexamples, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Examplestores$Operations$List, + fetchExamples( + params?: Params$Resource$Projects$Locations$Examplestores$Fetchexamples, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Examplestores$Operations$List, + ): GaxiosPromise; + fetchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Fetchexamples, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Examplestores$Operations$List, + fetchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Fetchexamples, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Examplestores$Operations$List, - callback: BodyResponseCallback + fetchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Fetchexamples, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + fetchExamples( + callback: BodyResponseCallback ): void; - list( + fetchExamples( paramsOrCallback?: - | Params$Resource$Projects$Locations$Examplestores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$Fetchexamples + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Examplestores$Operations$List; + {}) as Params$Resource$Projects$Locations$Examplestores$Fetchexamples; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Examplestores$Operations$List; + {} as Params$Resource$Projects$Locations$Examplestores$Fetchexamples; options = {}; } @@ -40007,92 +41536,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+exampleStore}:fetchExamples').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['exampleStore'], + pathParams: ['exampleStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Get an ExampleStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Examplestores$Get, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Examplestores$Get, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Examplestores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Examplestores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Examplestores$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Examplestores$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$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$Examplestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Examplestores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Examplestores$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Examplestores$Get; options = {}; } @@ -40105,11 +41633,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -40120,142 +41645,76 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Examplestores$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Examplestores$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Examplestores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Examplestores$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 interface Params$Resource$Projects$Locations$Examplestores$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Extensioncontrollers { - context: APIRequestContext; - operations: Resource$Projects$Locations$Extensioncontrollers$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Extensioncontrollers$Operations( - this.context + return createAPIRequest( + parameters ); - } - } - - export class Resource$Projects$Locations$Extensioncontrollers$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`. + * List ExampleStores in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, + list( + params: Params$Resource$Projects$Locations$Examplestores$List, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, + list( + params?: Params$Resource$Projects$Locations$Examplestores$List, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Examplestores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Examplestores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Examplestores$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$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$Extensioncontrollers$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Examplestores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Examplestores$List; options = {}; } @@ -40268,86 +41727,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/exampleStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Update an ExampleStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Extensioncontrollers$Operations$Delete, + patch( + params: Params$Resource$Projects$Locations$Examplestores$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Examplestores$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Examplestores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Examplestores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Examplestores$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$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$Extensioncontrollers$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Examplestores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Examplestores$Patch; options = {}; } @@ -40361,7 +41825,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -40372,75 +41836,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Remove Examples from the Example 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$Extensioncontrollers$Operations$Get, + removeExamples( + params: Params$Resource$Projects$Locations$Examplestores$Removeexamples, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, + removeExamples( + params?: Params$Resource$Projects$Locations$Examplestores$Removeexamples, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, + ): GaxiosPromise; + removeExamples( + params: Params$Resource$Projects$Locations$Examplestores$Removeexamples, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, + removeExamples( + params: Params$Resource$Projects$Locations$Examplestores$Removeexamples, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, - callback: BodyResponseCallback + removeExamples( + params: Params$Resource$Projects$Locations$Examplestores$Removeexamples, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + removeExamples( + callback: BodyResponseCallback ): void; - get( + removeExamples( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$Removeexamples + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get; + {}) as Params$Resource$Projects$Locations$Examplestores$Removeexamples; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get; + {} as Params$Resource$Projects$Locations$Examplestores$Removeexamples; options = {}; } @@ -40453,87 +41917,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+exampleStore}:removeExamples').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['exampleStore'], + pathParams: ['exampleStore'], 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`. + * Search for similar Examples for given selection criteria. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Extensioncontrollers$Operations$List, + searchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Searchexamples, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, + searchExamples( + params?: Params$Resource$Projects$Locations$Examplestores$Searchexamples, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, + ): GaxiosPromise; + searchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Searchexamples, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, + searchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Searchexamples, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, - callback: BodyResponseCallback + searchExamples( + params: Params$Resource$Projects$Locations$Examplestores$Searchexamples, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + searchExamples( + callback: BodyResponseCallback ): void; - list( + searchExamples( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$Searchexamples + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List; + {}) as Params$Resource$Projects$Locations$Examplestores$Searchexamples; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List; + {} as Params$Resource$Projects$Locations$Examplestores$Searchexamples; options = {}; } @@ -40546,92 +42015,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+exampleStore}:searchExamples').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['exampleStore'], + pathParams: ['exampleStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Create or update Examples in the Example 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. */ - wait( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, + upsertExamples( + params: Params$Resource$Projects$Locations$Examplestores$Upsertexamples, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, + upsertExamples( + params?: Params$Resource$Projects$Locations$Examplestores$Upsertexamples, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, + ): GaxiosPromise; + upsertExamples( + params: Params$Resource$Projects$Locations$Examplestores$Upsertexamples, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, + upsertExamples( + params: Params$Resource$Projects$Locations$Examplestores$Upsertexamples, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, - callback: BodyResponseCallback + upsertExamples( + params: Params$Resource$Projects$Locations$Examplestores$Upsertexamples, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + upsertExamples( + callback: BodyResponseCallback ): void; - wait( + upsertExamples( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$Upsertexamples + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Examplestores$Upsertexamples; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait; + {} as Params$Resource$Projects$Locations$Examplestores$Upsertexamples; options = {}; } @@ -40644,7 +42113,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+exampleStore}:upsertExamples').replace( /([^:]\/)\/+/g, '$1' ), @@ -40654,142 +42123,214 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['exampleStore'], + pathParams: ['exampleStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } + return createAPIRequest( + parameters + ); + } } } - export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel + export interface Params$Resource$Projects$Locations$Examplestores$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Output only. Timestamp when this ExampleStore was created. */ - name?: string; + 'exampleStore.createTime'?: string; + /** + * Optional. Description of the ExampleStore. + */ + 'exampleStore.description'?: string; + /** + * Required. Display name of the ExampleStore. + */ + 'exampleStore.displayName'?: string; + /** + * Required. The embedding model to be used for vector embedding. Immutable. Supported models: * "text-embedding-005" * "text-multilingual-embedding-002" + */ + 'exampleStore.exampleStoreConfig.vertexEmbeddingModel'?: string; + /** + * Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project\}/locations/{location\}/exampleStores/{example_store\} + */ + 'exampleStore.name'?: string; + /** + * Output only. Timestamp when this ExampleStore was most recently updated. + */ + 'exampleStore.updateTime'?: string; + /** + * Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete + export interface Params$Resource$Projects$Locations$Examplestores$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project\}/locations/{location\}/exampleStores/{example_store\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get + export interface Params$Resource$Projects$Locations$Examplestores$Fetchexamples extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project\}/locations/{location\}/exampleStores/{example_store\}` */ - name?: string; + exampleStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FetchExamplesRequest; } - export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List + export interface Params$Resource$Projects$Locations$Examplestores$Get extends StandardParameters { /** - * The standard list filter. + * Required. The resource name of the ExampleStore. Format: `projects/{project\}/locations/{location\}/exampleStores/{example_store\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Examplestores$List + extends StandardParameters { /** - * The name of the operation's parent resource. + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). */ - name?: string; + filter?: string; /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * Optional. The standard list page token. */ pageToken?: string; + /** + * Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait + export interface Params$Resource$Projects$Locations$Examplestores$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project\}/locations/{location\}/exampleStores/{example_store\} */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ExampleStore; } + export interface Params$Resource$Projects$Locations$Examplestores$Removeexamples + extends StandardParameters { + /** + * Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project\}/locations/{location\}/exampleStores/{example_store\}` + */ + exampleStore?: string; - export class Resource$Projects$Locations$Extensions { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RemoveExamplesRequest; + } + export interface Params$Resource$Projects$Locations$Examplestores$Searchexamples + extends StandardParameters { + /** + * Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project\}/locations/{location\}/exampleStores/{example_store\}` + */ + exampleStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchExamplesRequest; + } + export interface Params$Resource$Projects$Locations$Examplestores$Upsertexamples + extends StandardParameters { + /** + * Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project\}/locations/{location\}/exampleStores/{example_store\}` + */ + exampleStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1UpsertExamplesRequest; + } + + export class Resource$Projects$Locations$Examplestores$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Extensions$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Extensions$Operations( - this.context - ); } /** - * Deletes an Extension. + * 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. */ - delete( - params: Params$Resource$Projects$Locations$Extensions$Delete, + cancel( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Extensions$Delete, + cancel( + params?: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Extensions$Delete, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Extensions$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Extensions$Delete, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Cancel, + callback: BodyResponseCallback ): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$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$Extensions$Delete; + {}) as Params$Resource$Projects$Locations$Examplestores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Extensions$Delete; + params = + {} as Params$Resource$Projects$Locations$Examplestores$Operations$Cancel; options = {}; } @@ -40802,8 +42343,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -40814,74 +42358,71 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Executes the request against a given extension. + * 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. */ - execute( - params: Params$Resource$Projects$Locations$Extensions$Execute, + delete( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - execute( - params?: Params$Resource$Projects$Locations$Extensions$Execute, + delete( + params?: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - execute( - params: Params$Resource$Projects$Locations$Extensions$Execute, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - execute( - params: Params$Resource$Projects$Locations$Extensions$Execute, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - execute( - params: Params$Resource$Projects$Locations$Extensions$Execute, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - execute( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Delete, + callback: BodyResponseCallback ): void; - execute( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Execute - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$Operations$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$Extensions$Execute; + {}) as Params$Resource$Projects$Locations$Examplestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Extensions$Execute; + params = + {} as Params$Resource$Projects$Locations$Examplestores$Operations$Delete; options = {}; } @@ -40894,11 +42435,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:execute').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -40909,19 +42447,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets an Extension. + * 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`. @@ -40929,56 +42465,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Extensions$Get, + params: Params$Resource$Projects$Locations$Examplestores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Extensions$Get, + params?: Params$Resource$Projects$Locations$Examplestores$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Extensions$Get, + params: Params$Resource$Projects$Locations$Examplestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Extensions$Get, + params: Params$Resource$Projects$Locations$Examplestores$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Extensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Examplestores$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$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$Extensions$Get; + {}) as Params$Resource$Projects$Locations$Examplestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Extensions$Get; + params = + {} as Params$Resource$Projects$Locations$Examplestores$Operations$Get; options = {}; } @@ -41003,76 +42540,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Imports an Extension. + * 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. */ - import( - params: Params$Resource$Projects$Locations$Extensions$Import, + list( + params: Params$Resource$Projects$Locations$Examplestores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Extensions$Import, + list( + params?: Params$Resource$Projects$Locations$Examplestores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Extensions$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Examplestores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Extensions$Import, + list( + params: Params$Resource$Projects$Locations$Examplestores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Extensions$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Examplestores$Operations$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$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$Extensions$Import; + {}) as Params$Resource$Projects$Locations$Examplestores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Extensions$Import; + params = + {} as Params$Resource$Projects$Locations$Examplestores$Operations$List; options = {}; } @@ -41085,89 +42621,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/extensions:import').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists Extensions in a location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Extensions$List, + wait( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Extensions$List, + wait( + params?: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Extensions$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Extensions$List, + wait( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Extensions$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Examplestores$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Examplestores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensions$List; + {}) as Params$Resource$Projects$Locations$Examplestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Extensions$List; + params = + {} as Params$Resource$Projects$Locations$Examplestores$Operations$Wait; options = {}; } @@ -41180,376 +42719,157 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/extensions').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Examplestores$Operations$Cancel + extends StandardParameters { /** - * Updates an Extension. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Examplestores$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Examplestores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Examplestores$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 interface Params$Resource$Projects$Locations$Examplestores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Extensioncontrollers { + context: APIRequestContext; + operations: Resource$Projects$Locations$Extensioncontrollers$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Extensioncontrollers$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Extensioncontrollers$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. */ - patch( - params: Params$Resource$Projects$Locations$Extensions$Patch, + cancel( + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Extensions$Patch, + cancel( + params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Extensions$Patch, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Extensions$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Extensions$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel, + callback: BodyResponseCallback ): void; - patch( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensioncontrollers$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$Extensions$Patch; + {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Extensions$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 - ); - } - } - - /** - * Queries an extension with a default controller. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Projects$Locations$Extensions$Query, - options: StreamMethodOptions - ): GaxiosPromise; - query( - params?: Params$Resource$Projects$Locations$Extensions$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Projects$Locations$Extensions$Query, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Projects$Locations$Extensions$Query, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Projects$Locations$Extensions$Query, - callback: BodyResponseCallback - ): void; - query( - callback: BodyResponseCallback - ): void; - query( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Query - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensions$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Extensions$Query; - 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}: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$Projects$Locations$Extensions$Delete - extends StandardParameters { - /** - * Required. The name of the Extension resource to be deleted. Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Extensions$Execute - extends StandardParameters { - /** - * Required. Name (identifier) of the extension; Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ExecuteExtensionRequest; - } - export interface Params$Resource$Projects$Locations$Extensions$Get - extends StandardParameters { - /** - * Required. The name of the Extension resource. Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Extensions$Import - extends StandardParameters { - /** - * Required. The resource name of the Location to import the Extension in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Extension; - } - export interface Params$Resource$Projects$Locations$Extensions$List - extends StandardParameters { - /** - * Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the Extensions from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Extensions$Patch - extends StandardParameters { - /** - * Identifier. The resource name of the Extension. - */ - name?: string; - /** - * Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Extension; - } - export interface Params$Resource$Projects$Locations$Extensions$Query - extends StandardParameters { - /** - * Required. Name (identifier) of the extension; Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1QueryExtensionRequest; - } - - export class Resource$Projects$Locations$Extensions$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$Extensions$Operations$Cancel, - options: StreamMethodOptions - ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, - options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensions$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Extensions$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel; options = {}; } @@ -41595,31 +42915,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Extensions$Operations$Delete, + params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Operations$Delete + | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41635,13 +42955,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensions$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Extensions$Operations$Delete; + {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete; options = {}; } @@ -41684,27 +43004,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Extensions$Operations$Get, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Extensions$Operations$Get, + params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Extensions$Operations$Get, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Extensions$Operations$Get, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Extensions$Operations$Get, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -41712,7 +43032,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Operations$Get + | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41728,13 +43048,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensions$Operations$Get; + {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Extensions$Operations$Get; + {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get; options = {}; } @@ -41777,27 +43097,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Extensions$Operations$List, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Extensions$Operations$List, + params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Extensions$Operations$List, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Extensions$Operations$List, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Extensions$Operations$List, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List, callback: BodyResponseCallback ): void; list( @@ -41805,7 +43125,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Operations$List + | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41821,13 +43141,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensions$Operations$List; + {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Extensions$Operations$List; + {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List; options = {}; } @@ -41875,27 +43195,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Extensions$Operations$Wait, + params?: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, + params: Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -41903,7 +43223,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Extensions$Operations$Wait + | Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41919,13 +43239,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Extensions$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Extensions$Operations$Wait; + {} as Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait; options = {}; } @@ -41963,28 +43283,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Extensions$Operations$Cancel + export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Extensions$Operations$Delete + export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Extensions$Operations$Get + export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Extensions$Operations$List + export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$List extends StandardParameters { /** * The standard list filter. @@ -42003,7 +43323,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Extensions$Operations$Wait + export interface Params$Resource$Projects$Locations$Extensioncontrollers$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -42015,62 +43335,54 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Featuregroups { + export class Resource$Projects$Locations$Extensions { context: APIRequestContext; - featureMonitors: Resource$Projects$Locations$Featuregroups$Featuremonitors; - features: Resource$Projects$Locations$Featuregroups$Features; - operations: Resource$Projects$Locations$Featuregroups$Operations; + operations: Resource$Projects$Locations$Extensions$Operations; constructor(context: APIRequestContext) { this.context = context; - this.featureMonitors = - new Resource$Projects$Locations$Featuregroups$Featuremonitors( - this.context - ); - this.features = new Resource$Projects$Locations$Featuregroups$Features( + this.operations = new Resource$Projects$Locations$Extensions$Operations( this.context ); - this.operations = - new Resource$Projects$Locations$Featuregroups$Operations(this.context); } /** - * Creates a new FeatureGroup in a given project and location. + * Deletes an Extension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Create, + delete( + params: Params$Resource$Projects$Locations$Extensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featuregroups$Create, + delete( + params?: Params$Resource$Projects$Locations$Extensions$Delete, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + delete( + params: Params$Resource$Projects$Locations$Extensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + delete( + params: Params$Resource$Projects$Locations$Extensions$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + delete( + params: Params$Resource$Projects$Locations$Extensions$Delete, callback: BodyResponseCallback ): void; - create( + delete( callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Create + | Params$Resource$Projects$Locations$Extensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -42086,12 +43398,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Create; + {}) as Params$Resource$Projects$Locations$Extensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; + params = {} as Params$Resource$Projects$Locations$Extensions$Delete; options = {}; } @@ -42104,18 +43416,15 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -42129,64 +43438,64 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes a single FeatureGroup. + * Executes the request against a given extension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Delete, + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Delete, + execute( + params?: Params$Resource$Projects$Locations$Extensions$Execute, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + ): GaxiosPromise; + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, - callback: BodyResponseCallback + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + execute( + callback: BodyResponseCallback ): void; - delete( + execute( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$Execute + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; + {}) as Params$Resource$Projects$Locations$Extensions$Execute; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; + params = {} as Params$Resource$Projects$Locations$Extensions$Execute; options = {}; } @@ -42199,8 +43508,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+name}:execute').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -42211,17 +43523,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single FeatureGroup. + * Gets an Extension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -42229,56 +43543,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Projects$Locations$Extensions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Get, + params?: Params$Resource$Projects$Locations$Extensions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Projects$Locations$Extensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Projects$Locations$Extensions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Extensions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$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$Featuregroups$Get; + {}) as Params$Resource$Projects$Locations$Extensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; + params = {} as Params$Resource$Projects$Locations$Extensions$Get; options = {}; } @@ -42303,75 +43617,76 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Imports an Extension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Getiampolicy, + import( + params: Params$Resource$Projects$Locations$Extensions$Import, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + import( + params?: Params$Resource$Projects$Locations$Extensions$Import, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Extensions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Extensions$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Extensions$Import, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - getIamPolicy( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$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$Featuregroups$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Extensions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Extensions$Import; options = {}; } @@ -42384,7 +43699,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/extensions:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -42394,22 +43709,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists FeatureGroups in a given project and location. + * Lists Extensions in a location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -42417,56 +43732,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + params: Params$Resource$Projects$Locations$Extensions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$List, + params?: Params$Resource$Projects$Locations$Extensions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + params: Params$Resource$Projects$Locations$Extensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + params: Params$Resource$Projects$Locations$Extensions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Extensions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$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$Featuregroups$List; + {}) as Params$Resource$Projects$Locations$Extensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$List; + params = {} as Params$Resource$Projects$Locations$Extensions$List; options = {}; } @@ -42479,7 +43794,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureGroups').replace( + url: (rootUrl + '/v1beta1/{+parent}/extensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -42494,19 +43809,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single FeatureGroup. + * Updates an Extension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -42514,56 +43829,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + params: Params$Resource$Projects$Locations$Extensions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Patch, + params?: Params$Resource$Projects$Locations$Extensions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + params: Params$Resource$Projects$Locations$Extensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + params: Params$Resource$Projects$Locations$Extensions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Extensions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$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$Featuregroups$Patch; + {}) as Params$Resource$Projects$Locations$Extensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; + params = {} as Params$Resource$Projects$Locations$Extensions$Patch; options = {}; } @@ -42588,169 +43903,76 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + 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$Featuregroups$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + return createAPIRequest( + parameters ); - } 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. + * Queries an extension with a default controller. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Testiampermissions, + query( + params: Params$Resource$Projects$Locations$Extensions$Query, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + query( + params?: Params$Resource$Projects$Locations$Extensions$Query, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + ): GaxiosPromise; + query( + params: Params$Resource$Projects$Locations$Extensions$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + query( + params: Params$Resource$Projects$Locations$Extensions$Query, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Extensions$Query, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + query( + callback: BodyResponseCallback ): void; - testIamPermissions( + query( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Extensions$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Extensions$Query; options = {}; } @@ -42763,7 +43985,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+name}:query').replace( /([^:]\/)\/+/g, '$1' ), @@ -42773,207 +43995,175 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + 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$Featuregroups$Create + export interface Params$Resource$Projects$Locations$Extensions$Delete extends StandardParameters { /** - * Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featureGroupId?: string; - /** - * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * Required. The name of the Extension resource to be deleted. Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureGroup; + name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Delete + export interface Params$Resource$Projects$Locations$Extensions$Execute extends StandardParameters { /** - * If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) + * Required. Name (identifier) of the extension; Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` */ - force?: boolean; + name?: string; + /** - * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1ExecuteExtensionRequest; } - export interface Params$Resource$Projects$Locations$Featuregroups$Get + export interface Params$Resource$Projects$Locations$Extensions$Get extends StandardParameters { /** - * Required. The name of the FeatureGroup resource. + * Required. The name of the Extension resource. Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Getiampolicy + export interface Params$Resource$Projects$Locations$Extensions$Import extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Required. The resource name of the Location to import the Extension in. Format: `projects/{project\}/locations/{location\}` */ - 'options.requestedPolicyVersion'?: number; + parent?: string; + /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Request body metadata */ - resource?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Extension; } - export interface Params$Resource$Projects$Locations$Featuregroups$List + export interface Params$Resource$Projects$Locations$Extensions$List extends StandardParameters { /** - * Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + * Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160). */ 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: * `create_time` * `update_time` + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. */ orderBy?: string; /** - * The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * Optional. The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. + * Optional. The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to list the Extensions from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Patch + export interface Params$Resource$Projects$Locations$Extensions$Patch extends StandardParameters { /** - * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + * Identifier. The resource name of the Extension. */ 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` * `service_agent_type` + * Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureGroup; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Extension; } - export interface Params$Resource$Projects$Locations$Featuregroups$Setiampolicy + export interface Params$Resource$Projects$Locations$Extensions$Query 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. + * Required. Name (identifier) of the extension; Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` */ - resource?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Testiampermissions - extends StandardParameters { - /** - * 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[]; - /** - * 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; + requestBody?: Schema$GoogleCloudAiplatformV1beta1QueryExtensionRequest; } - export class Resource$Projects$Locations$Featuregroups$Featuremonitors { + export class Resource$Projects$Locations$Extensions$Operations { context: APIRequestContext; - featureMonitorJobs: Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs; - operations: Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations; constructor(context: APIRequestContext) { this.context = context; - this.featureMonitorJobs = - new Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations( - this.context - ); } /** - * Creates a new FeatureMonitor in a given project, location and FeatureGroup. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, + cancel( + params: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, + cancel( + params?: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Extensions$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$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$Featuregroups$Featuremonitors$Create; + {}) as Params$Resource$Projects$Locations$Extensions$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create; + {} as Params$Resource$Projects$Locations$Extensions$Operations$Cancel; options = {}; } @@ -42986,7 +44176,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureMonitors').replace( + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), @@ -42996,22 +44186,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single FeatureMonitor. + * 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`. @@ -43019,57 +44209,53 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, + params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, + params?: Params$Resource$Projects$Locations$Extensions$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, + params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Extensions$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$Operations$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$Featuregroups$Featuremonitors$Delete; + {}) as Params$Resource$Projects$Locations$Extensions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete; + {} as Params$Resource$Projects$Locations$Extensions$Operations$Delete; options = {}; } @@ -43094,17 +44280,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single FeatureMonitor. + * 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`. @@ -43112,57 +44298,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, + params: Params$Resource$Projects$Locations$Extensions$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, + params?: Params$Resource$Projects$Locations$Extensions$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, + params: Params$Resource$Projects$Locations$Extensions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, + params: Params$Resource$Projects$Locations$Extensions$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Extensions$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$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$Featuregroups$Featuremonitors$Get; + {}) as Params$Resource$Projects$Locations$Extensions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get; + {} as Params$Resource$Projects$Locations$Extensions$Operations$Get; options = {}; } @@ -43187,19 +44373,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists FeatureGroups in a given project and location. + * 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`. @@ -43207,57 +44391,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, + params: Params$Resource$Projects$Locations$Extensions$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, + params?: Params$Resource$Projects$Locations$Extensions$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, + params: Params$Resource$Projects$Locations$Extensions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, + params: Params$Resource$Projects$Locations$Extensions$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Extensions$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Extensions$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$Featuregroups$Featuremonitors$List; + {}) as Params$Resource$Projects$Locations$Extensions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List; + {} as Params$Resource$Projects$Locations$Extensions$Operations$List; options = {}; } @@ -43270,7 +44454,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureMonitors').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -43280,60 +44464,60 @@ export namespace aiplatform_v1beta1 { 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 the parameters of a single FeatureMonitor. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + wait( + params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + wait( + params?: Params$Resource$Projects$Locations$Extensions$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + wait( + params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + wait( + params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + wait( + params: Params$Resource$Projects$Locations$Extensions$Operations$Wait, callback: BodyResponseCallback ): void; - patch( + wait( callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch + | Params$Resource$Projects$Locations$Extensions$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -43349,13 +44533,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch; + {}) as Params$Resource$Projects$Locations$Extensions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch; + {} as Params$Resource$Projects$Locations$Extensions$Operations$Wait; options = {}; } @@ -43368,8 +44552,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -43390,84 +44577,78 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create + export interface Params$Resource$Projects$Locations$Extensions$Operations$Cancel extends StandardParameters { /** - * Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup. - */ - featureMonitorId?: string; - /** - * Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project\}/locations/{location\}/featureGroups/{featuregroup\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureMonitor; + name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete + export interface Params$Resource$Projects$Locations$Extensions$Operations$Delete extends StandardParameters { /** - * Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get + export interface Params$Resource$Projects$Locations$Extensions$Operations$Get extends StandardParameters { /** - * Required. The name of the FeatureMonitor resource. + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List + export interface Params$Resource$Projects$Locations$Extensions$Operations$List extends StandardParameters { /** - * Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; - /** - * Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` - */ - parent?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch + export interface Params$Resource$Projects$Locations$Extensions$Operations$Wait extends StandardParameters { /** - * Identifier. Name of the FeatureMonitor. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}/featureMonitors/{featureMonitor\}` + * The name of the operation resource to wait on. */ 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 + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureMonitor; + timeout?: string; } - export class Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs { + export class Resource$Projects$Locations$Featuregroups { context: APIRequestContext; + featureMonitors: Resource$Projects$Locations$Featuregroups$Featuremonitors; + features: Resource$Projects$Locations$Featuregroups$Features; + operations: Resource$Projects$Locations$Featuregroups$Operations; constructor(context: APIRequestContext) { this.context = context; + this.featureMonitors = + new Resource$Projects$Locations$Featuregroups$Featuremonitors( + this.context + ); + this.features = new Resource$Projects$Locations$Featuregroups$Features( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featuregroups$Operations(this.context); } /** - * Creates a new feature monitor job. + * Creates a new FeatureGroup in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -43475,57 +44656,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, + params: Params$Resource$Projects$Locations$Featuregroups$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, + params?: Params$Resource$Projects$Locations$Featuregroups$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, + params: Params$Resource$Projects$Locations$Featuregroups$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, + params: Params$Resource$Projects$Locations$Featuregroups$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$Featuremonitors$Featuremonitorjobs$Create; + {}) as Params$Resource$Projects$Locations$Featuregroups$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; options = {}; } @@ -43538,7 +44718,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureMonitorJobs').replace( + url: (rootUrl + '/v1beta1/{+parent}/featureGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -43553,77 +44733,74 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Get a feature monitor job. + * Deletes a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$Featuremonitors$Featuremonitorjobs$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; options = {}; } @@ -43637,7 +44814,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -43648,77 +44825,74 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List feature monitor jobs. + * Gets details of a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Featuremonitors$Featuremonitorjobs$List, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$Featuremonitors$Featuremonitorjobs$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; options = {}; } @@ -43731,142 +44905,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureMonitorJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create - extends StandardParameters { - /** - * Optional. Output only. System-generated ID for feature monitor job. - */ - featureMonitorJobId?: string; - /** - * Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureMonitorJob; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get - extends StandardParameters { - /** - * Required. The name of the FeatureMonitorJob resource. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}/featureMonitorJobs/{feature_monitor_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List - extends StandardParameters { - /** - * Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be Examples: * `create_time \> "2020-01-01"` FeatureMonitorJobs created after 2020-01-01. - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` - */ - orderBy?: string; - /** - * Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Gets the 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. */ - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; options = {}; } @@ -43879,87 +44998,89 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Lists FeatureGroups in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Featuregroups$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$Featuremonitors$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Featuregroups$List; options = {}; } @@ -43972,87 +45093,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/featureGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates the parameters of a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Featuremonitors$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$Featuremonitors$Operations$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; options = {}; } @@ -44065,11 +45190,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -44080,77 +45202,73 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * 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. */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - wait( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; options = {}; } @@ -44163,7 +45281,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -44173,137 +45291,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$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 interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featuregroups$Features { - context: APIRequestContext; - operations: Resource$Projects$Locations$Featuregroups$Features$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Featuregroups$Features$Operations( - this.context - ); - } /** - * Creates a batch of Features in a given FeatureGroup. + * 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. */ - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - batchCreate( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + {}) as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + {} as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; options = {}; } @@ -44316,7 +45377,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/features:batchCreate').replace( + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), @@ -44326,22 +45387,149 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Featuregroups$Create + extends StandardParameters { /** - * Creates a new Feature in a given FeatureGroup. + * Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featureGroupId?: string; + /** + * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Delete + extends StandardParameters { + /** + * If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) + */ + force?: boolean; + /** + * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Get + extends StandardParameters { + /** + * Required. The name of the FeatureGroup resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$List + extends StandardParameters { + /** + * Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + */ + 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: * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + */ + 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` * `service_agent_type` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$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$Featuregroups$Testiampermissions + extends StandardParameters { + /** + * 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[]; + /** + * 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; + } + + export class Resource$Projects$Locations$Featuregroups$Featuremonitors { + context: APIRequestContext; + featureMonitorJobs: Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs; + operations: Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureMonitorJobs = + new Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations( + this.context + ); + } + + /** + * Creates a new FeatureMonitor in a given project, location and FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -44349,27 +45537,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create, callback: BodyResponseCallback ): void; create( @@ -44377,7 +45565,7 @@ export namespace aiplatform_v1beta1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Create + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44393,13 +45581,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create; options = {}; } @@ -44412,7 +45600,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/features').replace( + url: (rootUrl + '/v1beta1/{+parent}/featureMonitors').replace( /([^:]\/)\/+/g, '$1' ), @@ -44437,7 +45625,7 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes a single Feature. + * Deletes a single FeatureMonitor. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -44445,27 +45633,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete, callback: BodyResponseCallback ): void; delete( @@ -44473,7 +45661,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Delete + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44489,13 +45677,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete; options = {}; } @@ -44530,7 +45718,7 @@ export namespace aiplatform_v1beta1 { } /** - * Gets details of a single Feature. + * Gets details of a single FeatureMonitor. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -44538,57 +45726,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$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$Featuregroups$Features$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get; options = {}; } @@ -44613,19 +45801,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Features in a given FeatureGroup. + * Lists FeatureGroups in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -44633,57 +45821,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$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$Featuregroups$Features$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List; options = {}; } @@ -44696,7 +45884,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/features').replace( + url: (rootUrl + '/v1beta1/{+parent}/featureMonitors').replace( /([^:]\/)\/+/g, '$1' ), @@ -44711,19 +45899,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Feature. + * Updates the parameters of a single FeatureMonitor. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -44731,27 +45919,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, callback: BodyResponseCallback ): void; patch( @@ -44759,7 +45947,7 @@ export namespace aiplatform_v1beta1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Patch + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44775,13 +45963,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + {}) 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$Features$Patch; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch; options = {}; } @@ -44816,170 +46004,142 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate - extends StandardParameters { - /** - * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create extends StandardParameters { /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + * Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup. */ - featureId?: string; + featureMonitorId?: string; /** - * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project\}/locations/{location\}/featureGroups/{featuregroup\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureMonitor; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Delete extends StandardParameters { /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + * Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Get extends StandardParameters { /** - * Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range. - */ - 'featureStatsAndAnomalySpec.latestStatsCount'?: number; - /** - * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. - */ - 'featureStatsAndAnomalySpec.statsTimeRange.endTime'?: string; - /** - * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. - */ - 'featureStatsAndAnomalySpec.statsTimeRange.startTime'?: string; - /** - * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The name of the FeatureMonitor resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$List + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$List extends StandardParameters { /** - * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". */ filter?: string; /** - * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - */ - latestStatsCount?: number; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` */ orderBy?: string; /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` */ parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch extends StandardParameters { /** - * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * Identifier. Name of the FeatureMonitor. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}/featureMonitors/{featureMonitor\}` */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + * 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$GoogleCloudAiplatformV1beta1Feature; + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureMonitor; } - export class Resource$Projects$Locations$Featuregroups$Features$Operations { + export class Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Creates a new feature monitor 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. */ - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$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$Featuregroups$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create; options = {}; } @@ -44992,29 +46152,34 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/featureMonitorJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the 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. + * Get a feature monitor job. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -45022,57 +46187,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$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$Featuregroups$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get; options = {}; } @@ -45097,17 +46262,19 @@ export namespace aiplatform_v1beta1 { 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`. + * List feature monitor jobs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -45115,57 +46282,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$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$Featuregroups$Features$Operations$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List; options = {}; } @@ -45178,7 +46345,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/featureMonitorJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -45188,165 +46355,71 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Create + extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Optional. Output only. System-generated ID for feature monitor job. */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, - options: StreamMethodOptions - ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, - options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; - 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}:wait').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); - } - } - } + featureMonitorJobId?: string; + /** + * Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}` + */ + parent?: string; - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete - extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureMonitorJob; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the FeatureMonitorJob resource. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}/featureMonitorJobs/{feature_monitor_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs$List extends StandardParameters { /** - * The standard list filter. + * Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be Examples: * `create_time \> "2020-01-01"` FeatureMonitorJobs created after 2020-01-01. */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. */ pageSize?: number; /** - * The standard list page token. + * Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token. */ pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait - extends StandardParameters { /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/featureMonitors/{feature_monitor\}` */ - timeout?: string; + parent?: string; } - export class Resource$Projects$Locations$Featuregroups$Operations { + export class Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -45361,31 +46434,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45401,13 +46474,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete; options = {}; } @@ -45450,27 +46523,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -45478,7 +46551,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Get + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45494,13 +46567,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get; options = {}; } @@ -45543,27 +46616,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List, callback: BodyResponseCallback ): void; list( @@ -45571,7 +46644,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$List + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45587,13 +46660,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$List; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List; options = {}; } @@ -45641,27 +46714,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -45669,7 +46742,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45685,13 +46758,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait; options = {}; } @@ -45729,21 +46802,21 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$List + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$List extends StandardParameters { /** * The standard list filter. @@ -45762,7 +46835,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -45774,60 +46847,55 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Featureonlinestores { + export class Resource$Projects$Locations$Featuregroups$Features { context: APIRequestContext; - featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; - operations: Resource$Projects$Locations$Featureonlinestores$Operations; + operations: Resource$Projects$Locations$Featuregroups$Features$Operations; constructor(context: APIRequestContext) { this.context = context; - this.featureViews = - new Resource$Projects$Locations$Featureonlinestores$Featureviews( - this.context - ); this.operations = - new Resource$Projects$Locations$Featureonlinestores$Operations( + new Resource$Projects$Locations$Featuregroups$Features$Operations( this.context ); } /** - * Creates a new FeatureOnlineStore in a given project and location. + * Creates a batch of Features in a given FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + batchCreate( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, callback: BodyResponseCallback ): void; - create( + batchCreate( callback: BodyResponseCallback ): void; - create( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Create + | Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45843,13 +46911,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; options = {}; } @@ -45862,7 +46930,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureOnlineStores').replace( + url: (rootUrl + '/v1beta1/{+parent}/features:batchCreate').replace( /([^:]\/)\/+/g, '$1' ), @@ -45887,43 +46955,43 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * Creates a new Feature in a given FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Delete, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, callback: BodyResponseCallback ): void; - delete( + create( callback: BodyResponseCallback ): void; - delete( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Delete + | Params$Resource$Projects$Locations$Featuregroups$Features$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45939,13 +47007,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; options = {}; } @@ -45958,15 +47026,18 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -45980,65 +47051,65 @@ export namespace aiplatform_v1beta1 { } /** - * Gets details of a single FeatureOnlineStore. + * Deletes a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Get, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$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$Featureonlinestores$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; options = {}; } @@ -46052,7 +47123,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -46063,75 +47134,75 @@ export namespace aiplatform_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. + * Gets details of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Getiampolicy, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$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$Featureonlinestores$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; options = {}; } @@ -46144,32 +47215,31 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists FeatureOnlineStores in a given project and location. + * Lists Features in a given FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -46177,57 +47247,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$List, + params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$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$Featureonlinestores$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$List; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; options = {}; } @@ -46240,7 +47310,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureOnlineStores').replace( + url: (rootUrl + '/v1beta1/{+parent}/features').replace( /([^:]\/)\/+/g, '$1' ), @@ -46255,19 +47325,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single FeatureOnlineStore. + * Updates the parameters of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -46275,27 +47345,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, callback: BodyResponseCallback ): void; patch( @@ -46303,7 +47373,7 @@ export namespace aiplatform_v1beta1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Patch + | Params$Resource$Projects$Locations$Featuregroups$Features$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46319,13 +47389,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; options = {}; } @@ -46358,65 +47428,172 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate + extends StandardParameters { + /** + * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: 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$GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create + extends StandardParameters { + /** + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + */ + featureId?: string; + /** + * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete + extends StandardParameters { + /** + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get + extends StandardParameters { + /** + * Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range. + */ + 'featureStatsAndAnomalySpec.latestStatsCount'?: number; + /** + * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + */ + 'featureStatsAndAnomalySpec.statsTimeRange.endTime'?: string; + /** + * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + */ + 'featureStatsAndAnomalySpec.statsTimeRange.startTime'?: string; + /** + * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$List + extends StandardParameters { + /** + * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + */ + filter?: string; + /** + * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + */ + latestStatsCount?: number; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch + extends StandardParameters { + /** + * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; + } + + export class Resource$Projects$Locations$Featuregroups$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$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$Featureonlinestores$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; options = {}; } @@ -46429,90 +47606,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * 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. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - testIamPermissions( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$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$Featureonlinestores$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; options = {}; } @@ -46525,217 +47699,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Create - extends StandardParameters { - /** - * Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featureOnlineStoreId?: string; - /** - * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete - extends StandardParameters { - /** - * If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) - */ - force?: boolean; - /** - * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Get - extends StandardParameters { - /** - * Required. The name of the FeatureOnlineStore resource. + * 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. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$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$Featureonlinestores$List - extends StandardParameters { - /** - * Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". - */ - 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: * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch - extends StandardParameters { - /** - * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$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$Featureonlinestores$Testiampermissions - extends StandardParameters { - /** - * 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[]; - /** - * 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; - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews { - context: APIRequestContext; - featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; - operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.featureViewSyncs = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( - this.context - ); - } - - /** - * Creates a new FeatureView in a given FeatureOnlineStore. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$Create, + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$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$Featureonlinestores$Featureviews$Create; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List; options = {}; } @@ -46748,68 +47792,70 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureViews').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single FeatureView. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$Delete, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, callback: BodyResponseCallback ): void; - delete( + wait( callback: BodyResponseCallback ): void; - delete( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46825,13 +47871,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; options = {}; } @@ -46844,8 +47890,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -46864,67 +47913,115 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + extends StandardParameters { /** - * Fetch feature values under a FeatureView. + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$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 interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featuregroups$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. */ - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - fetchFeatureValues( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchFeatureValues( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + callback: BodyResponseCallback ): void; - fetchFeatureValues( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Operations$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$Featureonlinestores$Featureviews$Fetchfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; options = {}; } @@ -46937,33 +48034,29 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+featureView}:fetchFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets details of a single FeatureView. + * 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`. @@ -46971,57 +48064,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$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$Featureonlinestores$Featureviews$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; options = {}; } @@ -47046,75 +48139,75 @@ export namespace aiplatform_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 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. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$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$Featureonlinestores$Featureviews$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$List; options = {}; } @@ -47127,90 +48220,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + 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 + ); } } /** - * Lists FeatureViews in a given FeatureOnlineStore. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$List, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; options = {}; } @@ -47223,70 +48318,130 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureViews').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + extends StandardParameters { /** - * Updates the parameters of a single FeatureView. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 name of the operation resource to be deleted. */ - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$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 interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores { + context: APIRequestContext; + featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; + operations: Resource$Projects$Locations$Featureonlinestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViews = + new Resource$Projects$Locations$Featureonlinestores$Featureviews( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Operations( + this.context + ); + } + + /** + * Creates a new FeatureOnlineStore 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$Featureonlinestores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + | Params$Resource$Projects$Locations$Featureonlinestores$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47302,13 +48457,109 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/featureOnlineStores').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 FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; options = {}; } @@ -47322,7 +48573,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -47343,65 +48594,65 @@ export namespace aiplatform_v1beta1 { } /** - * Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. + * Gets details of a single FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, options: StreamMethodOptions ): GaxiosPromise; - searchNearestEntities( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, options?: MethodOptions - ): GaxiosPromise; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + callback: BodyResponseCallback ): void; - searchNearestEntities( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - searchNearestEntities( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$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$Featureonlinestores$Featureviews$Searchnearestentities; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; options = {}; } @@ -47414,67 +48665,65 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+featureView}:searchNearestEntities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets 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$Featureonlinestores$Featureviews$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47490,13 +48739,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; options = {}; } @@ -47509,7 +48758,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -47534,65 +48783,65 @@ export namespace aiplatform_v1beta1 { } /** - * Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. + * Lists FeatureOnlineStores 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. */ - streamingFetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, options: StreamMethodOptions ): GaxiosPromise; - streamingFetchFeatureValues( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$List, options?: MethodOptions - ): GaxiosPromise; - streamingFetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamingFetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamingFetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + callback: BodyResponseCallback ): void; - streamingFetchFeatureValues( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - streamingFetchFeatureValues( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$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$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues; + {} as Params$Resource$Projects$Locations$Featureonlinestores$List; options = {}; } @@ -47605,91 +48854,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+featureView}:streamingFetchFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+parent}/featureOnlineStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Triggers on-demand sync for the FeatureView. + * Updates the parameters of a single FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options: StreamMethodOptions ): GaxiosPromise; - sync( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options?: MethodOptions - ): GaxiosPromise; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + callback: BodyResponseCallback ): void; - sync( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - sync( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$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$Featureonlinestores$Featureviews$Sync; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; options = {}; } @@ -47702,92 +48952,85 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+featureView}:sync').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * 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. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - testIamPermissions( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; options = {}; } @@ -47800,7 +49043,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -47815,65 +49058,149 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create - extends StandardParameters { - /** - * Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. - */ - featureViewId?: string; - /** - * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - parent?: string; - /** - * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. - */ - runSyncImmediately?: boolean; /** - * Request body metadata + * 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. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete - extends StandardParameters { - /** - * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Create extends StandardParameters { /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. */ - featureView?: string; + featureOnlineStoreId?: string; + /** + * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete extends StandardParameters { /** - * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) + */ + force?: boolean; + /** + * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + export interface Params$Resource$Projects$Locations$Featureonlinestores$Get + extends StandardParameters { + /** + * Required. The name of the FeatureOnlineStore resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$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). @@ -47884,58 +49211,46 @@ export namespace aiplatform_v1beta1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + export interface Params$Resource$Projects$Locations$Featureonlinestores$List extends StandardParameters { /** - * Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. + * Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". */ 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: * `feature_view_id` * `create_time` * `update_time` + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` */ orderBy?: string; /** - * The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. */ pageSize?: number; /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch extends StandardParameters { /** - * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities - extends StandardParameters { - /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + export interface Params$Resource$Projects$Locations$Featureonlinestores$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. @@ -47947,31 +49262,7 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues - extends StandardParameters { - /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync - extends StandardParameters { - /** - * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + export interface Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions extends StandardParameters { /** * 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). @@ -47983,72 +49274,82 @@ export namespace aiplatform_v1beta1 { resource?: string; } - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { + export class Resource$Projects$Locations$Featureonlinestores$Featureviews { context: APIRequestContext; + featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; + operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; constructor(context: APIRequestContext) { this.context = context; + this.featureViewSyncs = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( + this.context + ); } /** - * Gets details of a single FeatureViewSync. + * Creates a new FeatureView in a given FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; options = {}; } @@ -48061,89 +49362,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+parent}/featureViews').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 FeatureViewSyncs in a given FeatureView. + * Deletes a single FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$Featureviewsyncs$List, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Featureonlinestores$Featureviews$Featureviewsyncs$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; options = {}; } @@ -48156,126 +49458,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featureViewSyncs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get - extends StandardParameters { - /** - * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List - extends StandardParameters { - /** - * Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. - */ - 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: * `create_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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`. + * Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$Operations$Delete, + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + directWrite( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + ): GaxiosPromise; + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - callback: BodyResponseCallback + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + directWrite( + callback: BodyResponseCallback + ): void; + directWrite( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; options = {}; } @@ -48288,87 +49551,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+featureView}:directWrite').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Fetch feature values under a FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$Operations$Get, + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + fetchFeatureValues( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + ): GaxiosPromise; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, - callback: BodyResponseCallback + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + fetchFeatureValues( + callback: BodyResponseCallback ): void; - get( + fetchFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; options = {}; } @@ -48381,87 +49649,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta1/{+featureView}:fetchFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['featureView'], + pathParams: ['featureView'], 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 details of a single FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Featureviews$Operations$List, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Featureonlinestores$Featureviews$Operations$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; options = {}; } @@ -48474,10 +49746,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -48489,77 +49758,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * 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. */ - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - wait( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; options = {}; } @@ -48572,7 +49839,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -48582,128 +49849,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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 interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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`. + * Lists FeatureViews in a given FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Featureonlinestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; options = {}; } @@ -48716,65 +49935,70 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/featureViews').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 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 the parameters of a single FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featureonlinestores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, callback: BodyResponseCallback ): void; - get( + patch( callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48790,13 +50014,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; options = {}; } @@ -48810,7 +50034,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -48831,65 +50055,65 @@ export namespace aiplatform_v1beta1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument 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. */ - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, + searchNearestEntities( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, + ): GaxiosPromise; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, - callback: BodyResponseCallback + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + searchNearestEntities( + callback: BodyResponseCallback ): void; - list( + searchNearestEntities( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$List; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; options = {}; } @@ -48902,92 +50126,89 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1beta1/{+featureView}:searchNearestEntities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * 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. */ - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - wait( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; options = {}; } @@ -49000,7 +50221,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -49010,138 +50231,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$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 interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featurestores { - context: APIRequestContext; - entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; - operations: Resource$Projects$Locations$Featurestores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.entityTypes = - new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); - this.operations = - new Resource$Projects$Locations$Featurestores$Operations(this.context); - } /** - * Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. + * Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - batchReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + streamingFetchFeatureValues( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + ): GaxiosPromise; + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, - callback: BodyResponseCallback + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( - callback: BodyResponseCallback + streamingFetchFeatureValues( + callback: BodyResponseCallback ): void; - batchReadFeatureValues( + streamingFetchFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues; options = {}; } @@ -49155,7 +50318,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: ( - rootUrl + '/v1beta1/{+featurestore}:batchReadFeatureValues' + rootUrl + '/v1beta1/{+featureView}:streamingFetchFeatureValues' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -49163,79 +50326,82 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['featurestore'], - pathParams: ['featurestore'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a new Featurestore in a given project and location. + * Triggers on-demand sync for the FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Create, + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Create, + sync( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + ): GaxiosPromise; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, - callback: BodyResponseCallback + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + sync( + callback: BodyResponseCallback ): void; - create( + sync( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Create; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Create; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; options = {}; } @@ -49248,7 +50414,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featurestores').replace( + url: (rootUrl + '/v1beta1/{+featureView}:sync').replace( /([^:]\/)\/+/g, '$1' ), @@ -49258,79 +50424,82 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; options = {}; } @@ -49343,29 +50512,209 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + extends StandardParameters { /** - * Gets details of a single Featurestore. + * Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. + */ + featureViewId?: string; + /** + * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + /** + * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. + */ + runSyncImmediately?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + extends StandardParameters { + /** + * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite + extends StandardParameters { + /** + * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + extends StandardParameters { + /** + * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Featureonlinestores$Featureviews$List + extends StandardParameters { + /** + * Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. + */ + 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: * `feature_view_id` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + extends StandardParameters { + /** + * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + extends StandardParameters { + /** + * 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[]; + /** + * 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; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single FeatureViewSync. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -49373,56 +50722,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featurestores$Get, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$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$Featurestores$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Get; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; options = {}; } @@ -49447,75 +50797,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists FeatureViewSyncs in a given FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$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$Featurestores$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; options = {}; } @@ -49528,89 +50880,126 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/featureViewSyncs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get + extends StandardParameters { /** - * Lists Featurestores in a given project and location. + * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List + extends StandardParameters { + /** + * Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. + */ + 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: * `create_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. */ - list( - params: Params$Resource$Projects$Locations$Featurestores$List, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$List, + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$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$Featurestores$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$List; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; options = {}; } @@ -49623,70 +51012,65 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/featurestores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Featurestore. + * 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$Featurestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Patch, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Patch + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49702,12 +51086,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Patch; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; options = {}; } @@ -49721,7 +51106,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -49742,160 +51127,65 @@ export namespace aiplatform_v1beta1 { } /** - * Searches Features matching a query in a given project. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - searchFeatures( - params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, options?: MethodOptions - ): GaxiosPromise; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - callback: BodyResponseCallback - ): void; - searchFeatures( - callback: BodyResponseCallback - ): void; - searchFeatures( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Searchfeatures - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; - 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}/featurestores:searchFeatures' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['location'], - pathParams: ['location'], - 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$Featurestores$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Featurestores$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List; options = {}; } @@ -49908,90 +51198,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + wait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - testIamPermissions( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; options = {}; } @@ -50004,7 +51296,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), @@ -50014,244 +51306,128 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - featurestore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Create - extends StandardParameters { - /** - * Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featurestoreId?: string; - /** - * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Featurestore; - } - export interface Params$Resource$Projects$Locations$Featurestores$Delete + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete extends StandardParameters { /** - * If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) - */ - force?: boolean; - /** - * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Get + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get extends StandardParameters { /** - * Required. The name of the Featurestore resource. + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$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$GoogleIamV1GetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$List + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$List extends StandardParameters { /** - * Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` - */ - orderBy?: string; - /** - * The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Patch - extends StandardParameters { - /** - * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * The name of the operation's parent resource. */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Featurestore 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` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Featurestore; - } - export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures - extends StandardParameters { - /** - * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` - */ - location?: string; - /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; - /** - * Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. - */ - query?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$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$Featurestores$Testiampermissions + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait 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. + * The name of the operation resource to wait on. */ - resource?: string; - + name?: string; /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes { + export class Resource$Projects$Locations$Featureonlinestores$Operations { context: APIRequestContext; - features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; constructor(context: APIRequestContext) { this.context = context; - this.features = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( - this.context - ); } /** - * Creates a new EntityType in a given Featurestore. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$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$Featurestores$Entitytypes$Create; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; options = {}; } @@ -50264,68 +51440,65 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/entityTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. + * 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$Featurestores$Entitytypes$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50341,13 +51514,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; options = {}; } @@ -50361,7 +51534,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -50382,65 +51555,65 @@ export namespace aiplatform_v1beta1 { } /** - * Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. + * 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. */ - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - deleteFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$List, + callback: BodyResponseCallback ): void; - deleteFeatureValues( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - deleteFeatureValues( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$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$Featurestores$Entitytypes$Deletefeaturevalues; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$List; options = {}; } @@ -50453,67 +51626,70 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+entityType}:deleteFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Exports Feature values from all the entities of a target EntityType. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - exportFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + wait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, callback: BodyResponseCallback ): void; - exportFeatureValues( + wait( callback: BodyResponseCallback ): void; - exportFeatureValues( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50529,13 +51705,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; options = {}; } @@ -50548,17 +51724,18 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+entityType}:exportFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -50570,67 +51747,125 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + extends StandardParameters { /** - * Gets details of a single EntityType. + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$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 interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featurestores { + context: APIRequestContext; + entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; + operations: Resource$Projects$Locations$Featurestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.entityTypes = + new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); + this.operations = + new Resource$Projects$Locations$Featurestores$Operations(this.context); + } + + /** + * Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Get, + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + batchReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + ): GaxiosPromise; + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, - callback: BodyResponseCallback + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchReadFeatureValues( + callback: BodyResponseCallback ): void; - get( + batchReadFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; options = {}; } @@ -50643,87 +51878,88 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta1/{+featurestore}:batchReadFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['featurestore'], + pathParams: ['featurestore'], 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. + * Creates a new Featurestore 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$Featurestores$Entitytypes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Featurestores$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$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$Featurestores$Entitytypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Featurestores$Create; options = {}; } @@ -50736,7 +51972,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/featurestores').replace( /([^:]\/)\/+/g, '$1' ), @@ -50746,58 +51982,58 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. + * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: StreamMethodOptions ): GaxiosPromise; - importFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Delete, options?: MethodOptions ): GaxiosPromise; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, callback: BodyResponseCallback ): void; - importFeatureValues( + delete( callback: BodyResponseCallback ): void; - importFeatureValues( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + | Params$Resource$Projects$Locations$Featurestores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50813,13 +52049,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; options = {}; } @@ -50832,17 +52067,15 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+entityType}:importFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -50856,65 +52089,64 @@ export namespace aiplatform_v1beta1 { } /** - * Lists EntityTypes in a given Featurestore. + * Gets details of a single Featurestore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$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$Featurestores$Entitytypes$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + params = {} as Params$Resource$Projects$Locations$Featurestores$Get; options = {}; } @@ -50927,92 +52159,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/entityTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single EntityType. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - patch( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; options = {}; } @@ -51025,89 +52252,89 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. + * Lists Featurestores 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. */ - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featurestores$List, options: StreamMethodOptions ): GaxiosPromise; - readFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + list( + params?: Params$Resource$Projects$Locations$Featurestores$List, options?: MethodOptions - ): GaxiosPromise; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featurestores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$List, + callback: BodyResponseCallback ): void; - readFeatureValues( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - readFeatureValues( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$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$Featurestores$Entitytypes$Readfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + params = {} as Params$Resource$Projects$Locations$Featurestores$List; options = {}; } @@ -51120,90 +52347,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+entityType}:readFeatureValues').replace( + url: (rootUrl + '/v1beta1/{+parent}/featurestores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Updates the parameters of a single Featurestore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Setiampolicy, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Patch, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - setIamPolicy( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$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$Featurestores$Entitytypes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; options = {}; } @@ -51216,90 +52444,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. + * Searches Features matching a query in a given project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: StreamMethodOptions ): GaxiosPromise; - streamingReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + searchFeatures( + params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options?: MethodOptions - ): GaxiosPromise; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + ): GaxiosPromise; + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, - callback: BodyResponseCallback + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - callback: BodyResponseCallback + searchFeatures( + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( + searchFeatures( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Searchfeatures + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; options = {}; } @@ -51313,90 +52538,88 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: ( - rootUrl + '/v1beta1/{+entityType}:streamingReadFeatureValues' + rootUrl + '/v1beta1/{+location}/featurestores:searchFeatures' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + 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. + * 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. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - testIamPermissions( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; options = {}; } @@ -51409,7 +52632,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -51424,77 +52647,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. + * 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. */ - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - writeFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + callback: BodyResponseCallback ): void; - writeFeatureValues( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - writeFeatureValues( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; options = {}; } @@ -51507,133 +52728,111 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+entityType}:writeFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create + export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues extends StandardParameters { /** - * Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. - */ - entityTypeId?: string; - /** - * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ - parent?: string; + featurestore?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1EntityType; + requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Create extends StandardParameters { /** - * If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) - */ - force?: boolean; - /** - * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues - extends StandardParameters { + featurestoreId?: string; /** - * Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` */ - entityType?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Featurestore; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues + export interface Params$Resource$Projects$Locations$Featurestores$Delete extends StandardParameters { /** - * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) */ - entityType?: string; - + force?: boolean; /** - * Request body metadata + * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get + export interface Params$Resource$Projects$Locations$Featurestores$Get extends StandardParameters { /** - * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * Required. The name of the Featurestore resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy + export interface Params$Resource$Projects$Locations$Featurestores$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$Featurestores$Entitytypes$Importfeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - */ - entityType?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest; + requestBody?: Schema$GoogleIamV1GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List + export interface Params$Resource$Projects$Locations$Featurestores$List extends StandardParameters { /** - * Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. + * Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". */ 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: * `entity_type_id` * `create_time` * `update_time` + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` */ orderBy?: string; /** - * The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. + * A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** @@ -51641,131 +52840,120 @@ export namespace aiplatform_v1beta1 { */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch + export interface Params$Resource$Projects$Locations$Featurestores$Patch extends StandardParameters { /** - * Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. + * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` + * Field mask is used to specify the fields to be overwritten in the Featurestore 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` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1EntityType; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Featurestore; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues + export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures extends StandardParameters { /** - * Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` */ - entityType?: string; - + location?: string; /** - * Request body metadata + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy - extends StandardParameters { + pageSize?: number; /** - * 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. + * A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. */ - resource?: string; - + pageToken?: string; /** - * Request body metadata + * Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + query?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues + export interface Params$Resource$Projects$Locations$Featurestores$Setiampolicy extends StandardParameters { /** - * Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * 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. */ - entityType?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest; + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions + export interface Params$Resource$Projects$Locations$Featurestores$Testiampermissions extends StandardParameters { - /** - * 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[]; /** * 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; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - */ - entityType?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest; + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { + export class Resource$Projects$Locations$Featurestores$Entitytypes { context: APIRequestContext; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; + features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; constructor(context: APIRequestContext) { this.context = context; + this.features = + new Resource$Projects$Locations$Featurestores$Entitytypes$Features( + this.context + ); this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( + new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( this.context ); } /** - * Creates a batch of Features in a given EntityType. + * Creates a new EntityType in a given Featurestore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Batchcreate, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + create( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options?: MethodOptions ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, callback: BodyResponseCallback ): void; - batchCreate( + create( callback: BodyResponseCallback ): void; - batchCreate( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51781,13 +52969,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; options = {}; } @@ -51800,7 +52988,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/features:batchCreate').replace( + url: (rootUrl + '/v1beta1/{+parent}/entityTypes').replace( /([^:]\/)\/+/g, '$1' ), @@ -51825,43 +53013,43 @@ export namespace aiplatform_v1beta1 { } /** - * Creates a new Feature in a given EntityType. + * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Create, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, callback: BodyResponseCallback ): void; - create( + delete( callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51877,13 +53065,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; options = {}; } @@ -51896,18 +53084,15 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/features').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -51921,43 +53106,43 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes a single Feature. + * Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Delete, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + deleteFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, callback: BodyResponseCallback ): void; - delete( + deleteFeatureValues( callback: BodyResponseCallback ): void; - delete( + deleteFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51973,13 +53158,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; options = {}; } @@ -51992,15 +53177,17 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta1/{+entityType}:deleteFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { @@ -52014,65 +53201,65 @@ export namespace aiplatform_v1beta1 { } /** - * Gets details of a single Feature. + * Exports Feature values from all the entities of a target EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Get, + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + exportFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + ): GaxiosPromise; + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, - callback: BodyResponseCallback + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + exportFeatureValues( + callback: BodyResponseCallback ): void; - get( + exportFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; options = {}; } @@ -52085,89 +53272,89 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta1/{+entityType}:exportFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Features in a given EntityType. + * Gets details of a single EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$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$Featurestores$Entitytypes$Features$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; options = {}; } @@ -52180,92 +53367,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/features').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Feature. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - patch( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; options = {}; } @@ -52278,194 +53460,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate - extends StandardParameters { - /** - * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create - extends StandardParameters { - /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. - */ - featureId?: string; - /** - * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete - extends StandardParameters { - /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get - extends StandardParameters { - /** - * Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range. - */ - 'featureStatsAndAnomalySpec.latestStatsCount'?: number; - /** - * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. - */ - 'featureStatsAndAnomalySpec.statsTimeRange.endTime'?: string; - /** - * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. - */ - 'featureStatsAndAnomalySpec.statsTimeRange.startTime'?: string; - /** - * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List - extends StandardParameters { - /** - * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. - */ - filter?: string; - /** - * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - */ - latestStatsCount?: number; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch - extends StandardParameters { - /** - * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; - } - - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$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`. + * Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Operations$Cancel, + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + importFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + ): GaxiosPromise; + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, - callback: BodyResponseCallback + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + importFeatureValues( + callback: BodyResponseCallback + ): void; + importFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; options = {}; } @@ -52478,86 +53556,89 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+entityType}:importFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists EntityTypes in a given Featurestore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$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$Featurestores$Entitytypes$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; options = {}; } @@ -52570,87 +53651,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/entityTypes').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 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 the parameters of a single EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$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$Featurestores$Entitytypes$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; options = {}; } @@ -52664,7 +53750,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -52675,75 +53761,77 @@ export namespace aiplatform_v1beta1 { 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`. + * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Features$Operations$List, + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + readFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + ): GaxiosPromise; + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, - options: + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, - callback: BodyResponseCallback + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + readFeatureValues( + callback: BodyResponseCallback ): void; - list( + readFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; options = {}; } @@ -52756,92 +53844,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+entityType}:readFeatureValues').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * 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. */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - wait( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; options = {}; } @@ -52854,7 +53940,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -52864,227 +53950,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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 interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featurestores$Entitytypes$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`. + * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Operations$Cancel, + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + streamingReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + ): GaxiosPromise; + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + options: | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; - 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}: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$Featurestores$Entitytypes$Operations$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, - callback: BodyResponseCallback + streamingReadFeatureValues( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + streamingReadFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; options = {}; } @@ -53097,87 +54036,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta1/{+entityType}:streamingReadFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - get( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; options = {}; } @@ -53190,87 +54133,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Entitytypes$Operations$List, + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + writeFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + ): GaxiosPromise; + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, - callback: BodyResponseCallback + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + writeFeatureValues( + callback: BodyResponseCallback ): void; - list( + writeFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; options = {}; } @@ -53283,243 +54231,287 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1beta1/{+entityType}:writeFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create + extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, - options: StreamMethodOptions - ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, - options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; - options = {}; - } + entityTypeId?: string; + /** + * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + parent?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1EntityType; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + extends StandardParameters { + /** + * If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) + */ + force?: boolean; + /** + * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + */ + entityType?: string; - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}:wait').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); - } - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest; } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + */ + entityType?: string; - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy extends StandardParameters { /** - * The name of the operation resource to be deleted. + * 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). */ - name?: string; + '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$Featurestores$Entitytypes$Operations$Get + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` */ - name?: string; + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List extends StandardParameters { /** - * The standard list filter. + * Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. */ filter?: string; /** - * The name of the operation's parent resource. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. */ pageToken?: string; + /** + * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1EntityType; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest; } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$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; - export class Resource$Projects$Locations$Featurestores$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions + extends StandardParameters { + /** + * 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[]; + /** + * 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; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { context: APIRequestContext; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( + this.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 batch of Features in a given EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Operations$Cancel, + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + batchCreate( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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$Featurestores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; options = {}; } @@ -53532,7 +54524,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/features:batchCreate').replace( /([^:]\/)\/+/g, '$1' ), @@ -53542,76 +54534,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a new Feature in a given EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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$Featurestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; options = {}; } @@ -53624,65 +54620,68 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Get + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53698,13 +54697,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; options = {}; } @@ -53718,7 +54717,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -53739,65 +54738,65 @@ export namespace aiplatform_v1beta1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets details of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Featurestores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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$Featurestores$Operations$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; options = {}; } @@ -53810,10 +54809,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -53825,77 +54821,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists Features in a given EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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$Featurestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; options = {}; } @@ -53908,96 +54904,238 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+parent}/features').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete - extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Updates the parameters of a single Feature. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get - extends StandardParameters { + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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$Featurestores$Entitytypes$Features$Batchcreate + extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create + extends StandardParameters { + /** + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + */ + featureId?: string; + /** + * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + extends StandardParameters { + /** + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$List + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get extends StandardParameters { /** - * The standard list filter. + * Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range. */ - filter?: string; + 'featureStatsAndAnomalySpec.latestStatsCount'?: number; /** - * The name of the operation's parent resource. + * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + */ + 'featureStatsAndAnomalySpec.statsTimeRange.endTime'?: string; + /** + * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + */ + 'featureStatsAndAnomalySpec.statsTimeRange.startTime'?: string; + /** + * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` */ name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + extends StandardParameters { /** - * The standard list page size. + * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + */ + filter?: string; + /** + * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + */ + latestStatsCount?: number; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. */ pageToken?: string; + /** + * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; } - export class Resource$Projects$Locations$Hyperparametertuningjobs { + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( - this.context - ); } /** - * Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `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`. @@ -54005,31 +55143,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54045,13 +55183,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; options = {}; } @@ -54089,65 +55227,61 @@ export namespace aiplatform_v1beta1 { } /** - * Creates a HyperparameterTuningJob + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$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$Hyperparametertuningjobs$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; options = {}; } @@ -54160,69 +55294,65 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+parent}/hyperparameterTuningJobs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a HyperparameterTuningJob. + * 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$Hyperparametertuningjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54238,13 +55368,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; options = {}; } @@ -54258,7 +55388,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -54279,65 +55409,65 @@ export namespace aiplatform_v1beta1 { } /** - * Gets a HyperparameterTuningJob + * 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$Hyperparametertuningjobs$Get, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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$Hyperparametertuningjobs$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; options = {}; } @@ -54350,7 +55480,10 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -54362,77 +55495,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists HyperparameterTuningJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Hyperparametertuningjobs$List, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; options = {}; } @@ -54445,95 +55578,84 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+parent}/hyperparameterTuningJobs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest; - } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1HyperparameterTuningJob; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * 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. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + * The standard list page token. */ pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + extends StandardParameters { /** - * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + * The name of the operation resource to wait on. */ - parent?: string; + name?: string; /** - * Mask specifying which fields to read. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - readMask?: string; + timeout?: string; } - export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { + export class Resource$Projects$Locations$Featurestores$Entitytypes$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -54548,31 +55670,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54588,13 +55710,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; options = {}; } @@ -54640,31 +55762,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54680,13 +55802,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; options = {}; } @@ -54729,27 +55851,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -54757,7 +55879,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54773,13 +55895,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; options = {}; } @@ -54822,27 +55944,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, callback: BodyResponseCallback ): void; list( @@ -54850,7 +55972,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54866,13 +55988,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; options = {}; } @@ -54920,27 +56042,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -54948,7 +56070,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54964,13 +56086,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; options = {}; } @@ -55008,28 +56130,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List extends StandardParameters { /** * The standard list filter. @@ -55048,7 +56170,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -55060,74 +56182,68 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Indexendpoints { + export class Resource$Projects$Locations$Featurestores$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Indexendpoints$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Indexendpoints$Operations(this.context); } /** - * Creates an IndexEndpoint. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Indexendpoints$Create, + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$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$Indexendpoints$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; options = {}; } @@ -55140,7 +56256,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/indexEndpoints').replace( + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), @@ -55150,22 +56266,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes an IndexEndpoint. + * 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`. @@ -55173,56 +56289,53 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$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$Indexendpoints$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; options = {}; } @@ -55247,53 +56360,53 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. + * 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. */ - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - deployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, callback: BodyResponseCallback ): void; - deployIndex( + get( callback: BodyResponseCallback ): void; - deployIndex( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Deployindex + | Params$Resource$Projects$Locations$Featurestores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -55309,13 +56422,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; options = {}; } @@ -55328,18 +56441,15 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+indexEndpoint}:deployIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -55353,65 +56463,65 @@ export namespace aiplatform_v1beta1 { } /** - * Finds the nearest neighbors of each vector within the request. + * 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. */ - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - findNeighbors( - params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + callback: BodyResponseCallback ): void; - findNeighbors( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - findNeighbors( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$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$Indexendpoints$Findneighbors; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; options = {}; } @@ -55424,91 +56534,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+indexEndpoint}:findNeighbors').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets an IndexEndpoint. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Indexendpoints$Get, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Get, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; options = {}; } @@ -55521,8 +56632,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -55533,76 +56647,135 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel + extends StandardParameters { /** - * Lists IndexEndpoints in a Location. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$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 interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Hyperparametertuningjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( + this.context + ); + } + + /** + * Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `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$Indexendpoints$List, + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Indexendpoints$List, + cancel( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$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$Indexendpoints$List; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; options = {}; } @@ -55615,92 +56788,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/indexEndpoints').replace( + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Update an existing DeployedIndex under an IndexEndpoint. + * Creates a HyperparameterTuningJob * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, options: StreamMethodOptions ): GaxiosPromise; - mutateDeployedIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + create( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, options?: MethodOptions - ): GaxiosPromise; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - mutateDeployedIndex( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$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$Indexendpoints$Mutatedeployedindex; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; options = {}; } @@ -55714,7 +56885,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: ( - rootUrl + '/v1beta1/{+indexEndpoint}:mutateDeployedIndex' + rootUrl + '/v1beta1/{+parent}/hyperparameterTuningJobs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -55722,79 +56893,82 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates an IndexEndpoint. + * Deletes a HyperparameterTuningJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Indexendpoints$Patch, + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, + delete( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$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$Indexendpoints$Patch; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Patch; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; options = {}; } @@ -55808,7 +56982,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -55819,77 +56993,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. + * Gets a HyperparameterTuningJob * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: StreamMethodOptions ): GaxiosPromise; - readIndexDatapoints( - params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + get( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options?: MethodOptions - ): GaxiosPromise; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - readIndexDatapoints( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$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$Indexendpoints$Readindexdatapoints; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; options = {}; } @@ -55902,91 +57074,89 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+indexEndpoint}:readIndexDatapoints' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. + * Lists HyperparameterTuningJobs in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: StreamMethodOptions ): GaxiosPromise; - undeployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + list( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options?: MethodOptions - ): GaxiosPromise; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + callback: BodyResponseCallback ): void; - undeployIndex( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - undeployIndex( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$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$Indexendpoints$Undeployindex; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; options = {}; } @@ -55999,158 +57169,95 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+indexEndpoint}:undeployIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1beta1/{+parent}/hyperparameterTuningJobs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + 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$Indexendpoints$Create + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1IndexEndpoint; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Delete - extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` */ - indexEndpoint?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1DeployIndexRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1HyperparameterTuningJob; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete extends StandardParameters { /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FindNeighborsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Get + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$List + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` */ filter?: string; /** - * Optional. The standard list page size. + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + * The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** - * Optional. Mask specifying which fields to read. + * Mask specifying which fields to read. */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex - extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1DeployedIndex; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Patch - extends StandardParameters { - /** - * Output only. The resource name of the IndexEndpoint. - */ - name?: string; - /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1IndexEndpoint; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints - extends StandardParameters { - /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex - extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1UndeployIndexRequest; - } - export class Resource$Projects$Locations$Indexendpoints$Operations { + export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -56165,31 +57272,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56205,13 +57312,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; options = {}; } @@ -56257,31 +57364,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56297,13 +57404,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; options = {}; } @@ -56346,27 +57453,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -56374,7 +57481,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56390,13 +57497,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; options = {}; } @@ -56439,27 +57546,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -56467,7 +57574,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$List + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56483,13 +57590,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; options = {}; } @@ -56537,27 +57644,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -56565,7 +57672,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56581,13 +57688,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; options = {}; } @@ -56625,28 +57732,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$List + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -56665,7 +57772,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -56677,18 +57784,17 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Indexes { + export class Resource$Projects$Locations$Indexendpoints { context: APIRequestContext; - operations: Resource$Projects$Locations$Indexes$Operations; + operations: Resource$Projects$Locations$Indexendpoints$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Indexes$Operations( - this.context - ); + this.operations = + new Resource$Projects$Locations$Indexendpoints$Operations(this.context); } /** - * Creates an Index. + * Creates an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -56696,27 +57802,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Indexendpoints$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Indexes$Create, + params?: Params$Resource$Projects$Locations$Indexendpoints$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Indexendpoints$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Indexendpoints$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Indexendpoints$Create, callback: BodyResponseCallback ): void; create( @@ -56724,7 +57830,7 @@ export namespace aiplatform_v1beta1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Create + | Params$Resource$Projects$Locations$Indexendpoints$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56740,12 +57846,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Create; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Create; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; options = {}; } @@ -56758,7 +57864,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/indexes').replace( + url: (rootUrl + '/v1beta1/{+parent}/indexEndpoints').replace( /([^:]\/)\/+/g, '$1' ), @@ -56783,7 +57889,7 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. + * Deletes an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -56791,27 +57897,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Indexes$Delete, + params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, callback: BodyResponseCallback ): void; delete( @@ -56819,7 +57925,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Delete + | Params$Resource$Projects$Locations$Indexendpoints$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56835,12 +57941,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Delete; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; options = {}; } @@ -56875,64 +57981,65 @@ export namespace aiplatform_v1beta1 { } /** - * Gets an Index. + * 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`. * @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$Indexes$Get, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Indexes$Get, + deployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Indexes$Get, + ): GaxiosPromise; + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexes$Get, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexes$Get, - callback: BodyResponseCallback + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + deployIndex( + callback: BodyResponseCallback ): void; - get( + deployIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Deployindex + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Get; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; options = {}; } @@ -56945,88 +58052,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+indexEndpoint}:deployIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Indexes in a Location. + * Finds the nearest neighbors of each vector within 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. */ - list( - params: Params$Resource$Projects$Locations$Indexes$List, + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Indexes$List, + findNeighbors( + params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Indexes$List, + ): GaxiosPromise; + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexes$List, + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexes$List, - callback: BodyResponseCallback + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + findNeighbors( + callback: BodyResponseCallback ): void; - list( + findNeighbors( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$List; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$List; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; options = {}; } @@ -57039,91 +58148,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/indexes').replace( + url: (rootUrl + '/v1beta1/{+indexEndpoint}:findNeighbors').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Index. + * Gets an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Indexes$Patch, + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Indexes$Patch, + get( + params?: Params$Resource$Projects$Locations$Indexendpoints$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$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$Indexes$Patch; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Patch; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; options = {}; } @@ -57137,7 +58246,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -57148,75 +58257,76 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Remove Datapoints from an Index. + * Lists IndexEndpoints in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: StreamMethodOptions ): GaxiosPromise; - removeDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + list( + params?: Params$Resource$Projects$Locations$Indexendpoints$List, options?: MethodOptions - ): GaxiosPromise; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + callback: BodyResponseCallback ): void; - removeDatapoints( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - removeDatapoints( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Removedatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$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$Indexes$Removedatapoints; + {}) as Params$Resource$Projects$Locations$Indexendpoints$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; options = {}; } @@ -57229,92 +58339,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+index}:removeDatapoints').replace( + url: (rootUrl + '/v1beta1/{+parent}/indexEndpoints').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Add/update Datapoints into an Index. + * Update an existing DeployedIndex under an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: StreamMethodOptions ): GaxiosPromise; - upsertDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + mutateDeployedIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options?: MethodOptions - ): GaxiosPromise; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + ): GaxiosPromise; + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, - callback: BodyResponseCallback + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + callback: BodyResponseCallback ): void; - upsertDatapoints( - callback: BodyResponseCallback + mutateDeployedIndex( + callback: BodyResponseCallback ): void; - upsertDatapoints( + mutateDeployedIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; options = {}; } @@ -57327,163 +58437,483 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+index}:upsertDatapoints').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+indexEndpoint}:mutateDeployedIndex' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Indexes$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Index; - } - export interface Params$Resource$Projects$Locations$Indexes$Delete - extends StandardParameters { - /** - * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Get - extends StandardParameters { - /** - * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Patch - extends StandardParameters { - /** - * Output only. The resource name of the Index. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Index; - } - export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints - extends StandardParameters { - /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - index?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1RemoveDatapointsRequest; - } - export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints - extends StandardParameters { - /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - index?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1UpsertDatapointsRequest; - } - - export class Resource$Projects$Locations$Indexes$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Updates an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Indexes$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + patch( + params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$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 + ); + } + } + + /** + * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved 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. + */ + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options: StreamMethodOptions + ): GaxiosPromise; + readIndexDatapoints( + params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options?: MethodOptions + ): GaxiosPromise; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+indexEndpoint}:readIndexDatapoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options: StreamMethodOptions + ): GaxiosPromise; + undeployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options?: MethodOptions + ): GaxiosPromise; + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + callback: BodyResponseCallback + ): void; + undeployIndex( + callback: BodyResponseCallback + ): void; + undeployIndex( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+indexEndpoint}:undeployIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Indexendpoints$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1IndexEndpoint; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Delete + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1DeployIndexRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + extends StandardParameters { + /** + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FindNeighborsRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Get + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + */ + filter?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1DeployedIndex; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Patch + extends StandardParameters { + /** + * Output only. The resource name of the IndexEndpoint. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1IndexEndpoint; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints + extends StandardParameters { + /** + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1UndeployIndexRequest; + } + + export class Resource$Projects$Locations$Indexendpoints$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$Indexendpoints$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Cancel + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -57499,13 +58929,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; options = {}; } @@ -57551,31 +58981,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Delete + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -57591,13 +59021,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; options = {}; } @@ -57640,27 +59070,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -57668,7 +59098,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Get + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -57684,13 +59114,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; options = {}; } @@ -57733,27 +59163,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Indexes$Operations$List, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, callback: BodyResponseCallback ): void; list( @@ -57761,7 +59191,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$List + | Params$Resource$Projects$Locations$Indexendpoints$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -57777,13 +59207,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$List; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; options = {}; } @@ -57831,27 +59261,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -57859,7 +59289,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Wait + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -57875,13 +59305,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; options = {}; } @@ -57919,28 +59349,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Get + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$List + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$List extends StandardParameters { /** * The standard list filter. @@ -57959,7 +59389,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -57971,33 +59401,18 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Metadatastores { + export class Resource$Projects$Locations$Indexes { context: APIRequestContext; - artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; - contexts: Resource$Projects$Locations$Metadatastores$Contexts; - executions: Resource$Projects$Locations$Metadatastores$Executions; - metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; - operations: Resource$Projects$Locations$Metadatastores$Operations; + operations: Resource$Projects$Locations$Indexes$Operations; constructor(context: APIRequestContext) { this.context = context; - this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( - this.context - ); - this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( + this.operations = new Resource$Projects$Locations$Indexes$Operations( this.context ); - this.executions = - new Resource$Projects$Locations$Metadatastores$Executions(this.context); - this.metadataSchemas = - new Resource$Projects$Locations$Metadatastores$Metadataschemas( - this.context - ); - this.operations = - new Resource$Projects$Locations$Metadatastores$Operations(this.context); } /** - * Initializes a MetadataStore, including allocation of resources. + * Creates an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -58005,27 +59420,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Metadatastores$Create, + params?: Params$Resource$Projects$Locations$Indexes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, callback: BodyResponseCallback ): void; create( @@ -58033,7 +59448,7 @@ export namespace aiplatform_v1beta1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Create + | Params$Resource$Projects$Locations$Indexes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58049,12 +59464,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Create; + {}) as Params$Resource$Projects$Locations$Indexes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; + params = {} as Params$Resource$Projects$Locations$Indexes$Create; options = {}; } @@ -58067,7 +59482,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/metadataStores').replace( + url: (rootUrl + '/v1beta1/{+parent}/indexes').replace( /([^:]\/)\/+/g, '$1' ), @@ -58092,7 +59507,7 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). + * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -58100,27 +59515,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Indexes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Delete, + params?: Params$Resource$Projects$Locations$Indexes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Indexes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Indexes$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Indexes$Delete, callback: BodyResponseCallback ): void; delete( @@ -58128,7 +59543,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Delete + | Params$Resource$Projects$Locations$Indexes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58144,12 +59559,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; + {}) as Params$Resource$Projects$Locations$Indexes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; + params = {} as Params$Resource$Projects$Locations$Indexes$Delete; options = {}; } @@ -58184,7 +59599,7 @@ export namespace aiplatform_v1beta1 { } /** - * Retrieves a specific MetadataStore. + * Gets an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -58192,56 +59607,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + params: Params$Resource$Projects$Locations$Indexes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Get, + params?: Params$Resource$Projects$Locations$Indexes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + params: Params$Resource$Projects$Locations$Indexes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + params: Params$Resource$Projects$Locations$Indexes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Indexes$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$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$Metadatastores$Get; + {}) as Params$Resource$Projects$Locations$Indexes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; + params = {} as Params$Resource$Projects$Locations$Indexes$Get; options = {}; } @@ -58266,19 +59681,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists MetadataStores for a Location. + * Lists Indexes in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -58286,56 +59701,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + params: Params$Resource$Projects$Locations$Indexes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Metadatastores$List, + params?: Params$Resource$Projects$Locations$Indexes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + params: Params$Resource$Projects$Locations$Indexes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + params: Params$Resource$Projects$Locations$Indexes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Indexes$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$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$Metadatastores$List; + {}) as Params$Resource$Projects$Locations$Indexes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$List; + params = {} as Params$Resource$Projects$Locations$Indexes$List; options = {}; } @@ -58348,7 +59763,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/metadataStores').replace( + url: (rootUrl + '/v1beta1/{+parent}/indexes').replace( /([^:]\/)\/+/g, '$1' ), @@ -58363,215 +59778,55 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Create - extends StandardParameters { - /** - * The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) - */ - metadataStoreId?: string; - /** - * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1MetadataStore; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Delete - extends StandardParameters { - /** - * Deprecated: Field is no longer supported. - */ - force?: boolean; - /** - * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Get - extends StandardParameters { - /** - * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$List - extends StandardParameters { - /** - * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - */ - pageToken?: string; - /** - * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Metadatastores$Artifacts { - context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( - this.context - ); - } - - /** - * Creates an Artifact associated with a MetadataStore. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Artifacts$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/artifacts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes an Artifact. + * Updates an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Artifacts$Delete, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + patch( + params?: Params$Resource$Projects$Locations$Indexes$Patch, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, callback: BodyResponseCallback ): void; - delete( + patch( callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete + | Params$Resource$Projects$Locations$Indexes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58587,13 +59842,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + {}) as Params$Resource$Projects$Locations$Indexes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + params = {} as Params$Resource$Projects$Locations$Indexes$Patch; options = {}; } @@ -58607,7 +59861,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -58628,65 +59882,65 @@ export namespace aiplatform_v1beta1 { } /** - * Retrieves a specific Artifact. + * Remove Datapoints from an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Artifacts$Get, + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + removeDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + ): GaxiosPromise; + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - callback: BodyResponseCallback + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + removeDatapoints( + callback: BodyResponseCallback ): void; - get( + removeDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Removedatapoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + {}) as Params$Resource$Projects$Locations$Indexes$Removedatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; options = {}; } @@ -58699,89 +59953,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+index}:removeDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['index'], + pathParams: ['index'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Artifacts in the MetadataStore. + * Add/update Datapoints into an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Artifacts$List, + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + upsertDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + ): GaxiosPromise; + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, - callback: BodyResponseCallback + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + upsertDatapoints( + callback: BodyResponseCallback ): void; - list( + upsertDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + {}) as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; options = {}; } @@ -58794,427 +60051,124 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/artifacts').replace( + url: (rootUrl + '/v1beta1/{+index}:upsertDatapoints').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['index'], + pathParams: ['index'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Indexes$Create + extends StandardParameters { /** - * Updates a stored Artifact. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Artifacts$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$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 - ); - } - } - - /** - * Purges Artifacts. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Artifacts$Purge, - options: StreamMethodOptions - ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - callback: BodyResponseCallback - ): void; - purge( - callback: BodyResponseCallback - ): void; - purge( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/artifacts: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); - } - } - - /** - * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - options: StreamMethodOptions - ): GaxiosPromise; - queryArtifactLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - options?: MethodOptions - ): GaxiosPromise; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - callback: BodyResponseCallback - ): void; - queryArtifactLineageSubgraph( - callback: BodyResponseCallback - ): void; - queryArtifactLineageSubgraph( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+artifact}:queryArtifactLineageSubgraph' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['artifact'], - pathParams: ['artifact'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create - extends StandardParameters { - /** - * The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) - */ - artifactId?: string; - /** - * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Artifact; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Index; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete + export interface Params$Resource$Projects$Locations$Indexes$Delete extends StandardParameters { /** - * Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - */ - etag?: string; - /** - * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get + export interface Params$Resource$Projects$Locations$Indexes$Get extends StandardParameters { /** - * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List + export interface Params$Resource$Projects$Locations$Indexes$List extends StandardParameters { /** - * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * The standard list filter. */ filter?: string; /** - * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - */ - orderBy?: string; - /** - * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. */ pageToken?: string; /** - * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch - extends StandardParameters { /** - * If set to true, and the Artifact is not found, a new Artifact is created. + * Mask specifying which fields to read. */ - allowMissing?: boolean; + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Patch + extends StandardParameters { /** - * Output only. The resource name of the Artifact. + * Output only. The resource name of the Index. */ name?: string; /** - * Optional. A FieldMask indicating which fields should be updated. + * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Artifact; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Index; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge + export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints extends StandardParameters { /** - * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` */ - parent?: string; + index?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeArtifactsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1RemoveDatapointsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph + export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints extends StandardParameters { /** - * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - */ - artifact?: string; - /** - * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` */ - filter?: string; + index?: string; + /** - * Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. + * Request body metadata */ - maxHops?: number; + requestBody?: Schema$GoogleCloudAiplatformV1beta1UpsertDatapointsRequest; } - export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { + export class Resource$Projects$Locations$Indexes$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -59229,31 +60183,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel + | Params$Resource$Projects$Locations$Indexes$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59269,13 +60223,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; options = {}; } @@ -59321,31 +60275,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete + | Params$Resource$Projects$Locations$Indexes$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59361,13 +60315,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; options = {}; } @@ -59410,27 +60364,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -59438,7 +60392,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get + | Params$Resource$Projects$Locations$Indexes$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59454,13 +60408,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; options = {}; } @@ -59503,27 +60457,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + params?: Params$Resource$Projects$Locations$Indexes$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Projects$Locations$Indexes$Operations$List, callback: BodyResponseCallback ): void; list( @@ -59531,7 +60485,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List + | Params$Resource$Projects$Locations$Indexes$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59547,13 +60501,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + {} as Params$Resource$Projects$Locations$Indexes$Operations$List; options = {}; } @@ -59601,27 +60555,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -59629,7 +60583,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait + | Params$Resource$Projects$Locations$Indexes$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59645,13 +60599,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; options = {}; } @@ -59689,28 +60643,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel + export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete + export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get + export interface Params$Resource$Projects$Locations$Indexes$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List + export interface Params$Resource$Projects$Locations$Indexes$Operations$List extends StandardParameters { /** * The standard list filter. @@ -59729,7 +60683,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait + export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -59741,77 +60695,90 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Metadatastores$Contexts { + export class Resource$Projects$Locations$Metadatastores { context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; + artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; + contexts: Resource$Projects$Locations$Metadatastores$Contexts; + executions: Resource$Projects$Locations$Metadatastores$Executions; + metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; + operations: Resource$Projects$Locations$Metadatastores$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Contexts$Operations( + this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( + this.context + ); + this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( + this.context + ); + this.executions = + new Resource$Projects$Locations$Metadatastores$Executions(this.context); + this.metadataSchemas = + new Resource$Projects$Locations$Metadatastores$Metadataschemas( this.context ); + this.operations = + new Resource$Projects$Locations$Metadatastores$Operations(this.context); } /** - * Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped. + * Initializes a MetadataStore, including allocation of 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. */ - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, options: StreamMethodOptions ): GaxiosPromise; - addContextArtifactsAndExecutions( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Create, options?: MethodOptions - ): GaxiosPromise; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$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$Metadatastores$Contexts$Addcontextartifactsandexecutions; + {}) as Params$Resource$Projects$Locations$Metadatastores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; options = {}; } @@ -59824,91 +60791,89 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+context}:addContextArtifactsAndExecutions' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/metadataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. + * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: StreamMethodOptions ): GaxiosPromise; - addContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Delete, options?: MethodOptions - ): GaxiosPromise; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, + callback: BodyResponseCallback ): void; - addContextChildren( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - addContextChildren( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$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$Metadatastores$Contexts$Addcontextchildren; + {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; options = {}; } @@ -59921,34 +60886,282 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+context}:addContextChildren').replace( + 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); + } + } + + /** + * Retrieves a specific MetadataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; + 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: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists MetadataStores for a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Metadatastores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/metadataStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + 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$Metadatastores$Create + extends StandardParameters { /** - * Creates a Context associated with a MetadataStore. + * The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) + */ + metadataStoreId?: string; + /** + * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1MetadataStore; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Delete + extends StandardParameters { + /** + * Deprecated: Field is no longer supported. + */ + force?: boolean; + /** + * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Get + extends StandardParameters { + /** + * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$List + extends StandardParameters { + /** + * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Artifacts { + context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( + this.context + ); + } + + /** + * Creates an Artifact associated with a MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -59956,57 +61169,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$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$Metadatastores$Contexts$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; options = {}; } @@ -60019,7 +61232,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/contexts').replace( + url: (rootUrl + '/v1beta1/{+parent}/artifacts').replace( /([^:]\/)\/+/g, '$1' ), @@ -60034,19 +61247,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a stored Context. + * Deletes an Artifact. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -60054,27 +61267,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, callback: BodyResponseCallback ): void; delete( @@ -60082,7 +61295,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60098,13 +61311,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; options = {}; } @@ -60139,7 +61352,7 @@ export namespace aiplatform_v1beta1 { } /** - * Retrieves a specific Context. + * Retrieves a specific Artifact. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -60147,57 +61360,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$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$Metadatastores$Contexts$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; options = {}; } @@ -60222,19 +61435,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Contexts on the MetadataStore. + * Lists Artifacts in the MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -60242,57 +61455,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$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$Metadatastores$Contexts$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; options = {}; } @@ -60305,7 +61518,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/contexts').replace( + url: (rootUrl + '/v1beta1/{+parent}/artifacts').replace( /([^:]\/)\/+/g, '$1' ), @@ -60320,19 +61533,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a stored Context. + * Updates a stored Artifact. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -60340,57 +61553,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$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$Metadatastores$Contexts$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; options = {}; } @@ -60415,19 +61628,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Purges Contexts. + * Purges Artifacts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -60435,27 +61648,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: StreamMethodOptions ): GaxiosPromise; purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options?: MethodOptions ): GaxiosPromise; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, callback: BodyResponseCallback ): void; purge( @@ -60463,7 +61676,7 @@ export namespace aiplatform_v1beta1 { ): void; purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60479,13 +61692,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; options = {}; } @@ -60498,7 +61711,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/contexts:purge').replace( + url: (rootUrl + '/v1beta1/{+parent}/artifacts:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -60523,43 +61736,43 @@ export namespace aiplatform_v1beta1 { } /** - * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. + * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: StreamMethodOptions ): GaxiosPromise; - queryContextLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryArtifactLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options?: MethodOptions ): GaxiosPromise; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( + queryArtifactLineageSubgraph( callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( + queryArtifactLineageSubgraph( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60575,13 +61788,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; options = {}; } @@ -60595,7 +61808,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: ( - rootUrl + '/v1beta1/{+context}:queryContextLineageSubgraph' + rootUrl + '/v1beta1/{+artifact}:queryArtifactLineageSubgraph' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -60603,8 +61816,8 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['artifact'], + pathParams: ['artifact'], context: this.context, }; if (callback) { @@ -60618,171 +61831,46 @@ export namespace aiplatform_v1beta1 { ); } } - - /** - * Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options: StreamMethodOptions - ): GaxiosPromise; - removeContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options?: MethodOptions - ): GaxiosPromise; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - callback: BodyResponseCallback - ): void; - removeContextChildren( - callback: BodyResponseCallback - ): void; - removeContextChildren( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+context}:removeContextChildren' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['context'], - pathParams: ['context'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions - extends StandardParameters { - /** - * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren - extends StandardParameters { - /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1AddContextChildrenRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create extends StandardParameters { /** - * The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) + * The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) */ - contextId?: string; + artifactId?: string; /** - * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Context; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Artifact; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete extends StandardParameters { /** - * Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. */ etag?: string; /** - * The force deletion semantics is still undefined. Users should not use this field. - */ - force?: boolean; - /** - * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get extends StandardParameters { /** - * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List extends StandardParameters { /** - * Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. */ filter?: string; /** @@ -60790,26 +61878,26 @@ export namespace aiplatform_v1beta1 { */ orderBy?: string; /** - * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) */ pageToken?: string; /** - * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch extends StandardParameters { /** - * If set to true, and the Context is not found, a new Context is created. + * If set to true, and the Artifact is not found, a new Artifact is created. */ allowMissing?: boolean; /** - * Immutable. The resource name of the Context. + * Output only. The resource name of the Artifact. */ name?: string; /** @@ -60820,41 +61908,37 @@ export namespace aiplatform_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Context; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Artifact; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge extends StandardParameters { /** - * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeContextsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeArtifactsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph extends StandardParameters { /** - * Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. */ - context?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren - extends StandardParameters { + artifact?: string; /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. */ - context?: string; - + filter?: string; /** - * Request body metadata + * Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest; + maxHops?: number; } - export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { + export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -60869,31 +61953,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60909,13 +61993,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; options = {}; } @@ -60961,31 +62045,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61001,13 +62085,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; options = {}; } @@ -61050,27 +62134,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -61078,7 +62162,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61094,13 +62178,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; options = {}; } @@ -61143,27 +62227,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -61171,7 +62255,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61187,13 +62271,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; options = {}; } @@ -61241,27 +62325,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -61269,7 +62353,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61285,13 +62369,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; options = {}; } @@ -61329,28 +62413,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List extends StandardParameters { /** * The standard list filter. @@ -61369,7 +62453,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -61381,77 +62465,77 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Metadatastores$Executions { + export class Resource$Projects$Locations$Metadatastores$Contexts { context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; + operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Metadatastores$Executions$Operations( + new Resource$Projects$Locations$Metadatastores$Contexts$Operations( this.context ); } /** - * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped. + * Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options: StreamMethodOptions ): GaxiosPromise; - addExecutionEvents( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + addContextArtifactsAndExecutions( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options?: MethodOptions - ): GaxiosPromise; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + ): GaxiosPromise; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, - callback: BodyResponseCallback + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + callback: BodyResponseCallback ): void; - addExecutionEvents( - callback: BodyResponseCallback + addContextArtifactsAndExecutions( + callback: BodyResponseCallback ): void; - addExecutionEvents( + addContextArtifactsAndExecutions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; options = {}; } @@ -61464,7 +62548,104 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+execution}:addExecutionEvents').replace( + url: ( + rootUrl + '/v1beta1/{+context}:addContextArtifactsAndExecutions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT 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. + */ + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: StreamMethodOptions + ): GaxiosPromise; + addContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options?: MethodOptions + ): GaxiosPromise; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + callback: BodyResponseCallback + ): void; + addContextChildren( + callback: BodyResponseCallback + ): void; + addContextChildren( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+context}:addContextChildren').replace( /([^:]\/)\/+/g, '$1' ), @@ -61474,24 +62655,24 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates an Execution associated with a MetadataStore. + * Creates a Context associated with a MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -61499,57 +62680,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$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$Metadatastores$Executions$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; options = {}; } @@ -61562,7 +62743,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/executions').replace( + url: (rootUrl + '/v1beta1/{+parent}/contexts').replace( /([^:]\/)\/+/g, '$1' ), @@ -61577,19 +62758,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes an Execution. + * Deletes a stored Context. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -61597,27 +62778,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, callback: BodyResponseCallback ): void; delete( @@ -61625,7 +62806,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61641,13 +62822,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; options = {}; } @@ -61682,7 +62863,7 @@ export namespace aiplatform_v1beta1 { } /** - * Retrieves a specific Execution. + * Retrieves a specific Context. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -61690,57 +62871,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$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$Metadatastores$Executions$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; options = {}; } @@ -61765,19 +62946,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Executions in the MetadataStore. + * Lists Contexts on the MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -61785,57 +62966,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$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$Metadatastores$Executions$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; options = {}; } @@ -61848,7 +63029,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/executions').replace( + url: (rootUrl + '/v1beta1/{+parent}/contexts').replace( /([^:]\/)\/+/g, '$1' ), @@ -61863,19 +63044,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a stored Execution. + * Updates a stored Context. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -61883,57 +63064,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$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$Metadatastores$Executions$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; options = {}; } @@ -61958,19 +63139,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Purges Executions. + * Purges Contexts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -61978,27 +63159,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: StreamMethodOptions ): GaxiosPromise; purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options?: MethodOptions ): GaxiosPromise; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, callback: BodyResponseCallback ): void; purge( @@ -62006,7 +63187,7 @@ export namespace aiplatform_v1beta1 { ): void; purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Purge + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62022,13 +63203,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; options = {}; } @@ -62041,7 +63222,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/executions:purge').replace( + url: (rootUrl + '/v1beta1/{+parent}/contexts:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -62066,43 +63247,43 @@ export namespace aiplatform_v1beta1 { } /** - * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. + * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: StreamMethodOptions ): GaxiosPromise; - queryExecutionInputsAndOutputs( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + queryContextLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options?: MethodOptions ): GaxiosPromise; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( + queryContextLineageSubgraph( callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( + queryContextLineageSubgraph( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62118,13 +63299,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; options = {}; } @@ -62138,7 +63319,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: ( - rootUrl + '/v1beta1/{+execution}:queryExecutionInputsAndOutputs' + rootUrl + '/v1beta1/{+context}:queryContextLineageSubgraph' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -62146,8 +63327,8 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { @@ -62161,58 +63342,171 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options: StreamMethodOptions + ): GaxiosPromise; + removeContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options?: MethodOptions + ): GaxiosPromise; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + callback: BodyResponseCallback + ): void; + removeContextChildren( + callback: BodyResponseCallback + ): void; + removeContextChildren( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+context}:removeContextChildren' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions extends StandardParameters { /** - * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` */ - execution?: string; + context?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1AddExecutionEventsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren extends StandardParameters { /** - * The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` */ - executionId?: string; + context?: string; + /** - * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1AddContextChildrenRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + extends StandardParameters { + /** + * The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) + */ + contextId?: string; + /** + * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Execution; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Context; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete extends StandardParameters { /** - * Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. */ etag?: string; /** - * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * The force deletion semantics is still undefined. Users should not use this field. + */ + force?: boolean; + /** + * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get extends StandardParameters { /** - * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List extends StandardParameters { /** - * Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. */ filter?: string; /** @@ -62220,26 +63514,26 @@ export namespace aiplatform_v1beta1 { */ orderBy?: string; /** - * The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) + * A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) */ pageToken?: string; /** - * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch extends StandardParameters { /** - * If set to true, and the Execution is not found, a new Execution is created. + * If set to true, and the Context is not found, a new Context is created. */ allowMissing?: boolean; /** - * Output only. The resource name of the Execution. + * Immutable. The resource name of the Context. */ name?: string; /** @@ -62250,29 +63544,41 @@ export namespace aiplatform_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Execution; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Context; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge extends StandardParameters { /** - * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeExecutionsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeContextsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph extends StandardParameters { /** - * Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. */ - execution?: string; + context?: string; } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + extends StandardParameters { + /** + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; - export class Resource$Projects$Locations$Metadatastores$Executions$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest; + } + + export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -62287,31 +63593,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62327,13 +63633,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; options = {}; } @@ -62379,31 +63685,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62419,13 +63725,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; options = {}; } @@ -62468,27 +63774,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -62496,7 +63802,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62512,13 +63818,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; options = {}; } @@ -62561,27 +63867,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -62589,7 +63895,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62605,13 +63911,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; options = {}; } @@ -62659,27 +63965,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -62687,7 +63993,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62703,13 +64009,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; options = {}; } @@ -62747,28 +64053,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List extends StandardParameters { /** * The standard list filter. @@ -62787,7 +64093,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -62799,72 +64105,77 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Metadatastores$Metadataschemas { + export class Resource$Projects$Locations$Metadatastores$Executions { context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Executions$Operations( + this.context + ); } /** - * Creates a MetadataSchema. + * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Metadataschemas$Create, + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + addExecutionEvents( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + ): GaxiosPromise; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, - callback: BodyResponseCallback + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + addExecutionEvents( + callback: BodyResponseCallback ): void; - create( + addExecutionEvents( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; options = {}; } @@ -62877,7 +64188,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/metadataSchemas').replace( + url: (rootUrl + '/v1beta1/{+execution}:addExecutionEvents').replace( /([^:]\/)\/+/g, '$1' ), @@ -62887,82 +64198,82 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['execution'], + pathParams: ['execution'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves a specific MetadataSchema. + * Creates an Execution associated with a MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Metadataschemas$Get, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$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$Metadatastores$Metadataschemas$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; options = {}; } @@ -62975,89 +64286,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+parent}/executions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists MetadataSchemas. + * Deletes an Execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$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$Metadatastores$Metadataschemas$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; options = {}; } @@ -63070,138 +64384,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/metadataSchemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create - extends StandardParameters { - /** - * The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) - */ - metadataSchemaId?: string; - /** - * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1MetadataSchema; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get - extends StandardParameters { - /** - * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List - extends StandardParameters { - /** - * A query to filter available MetadataSchemas for matching results. - */ - filter?: string; - /** - * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - */ - pageToken?: string; - /** - * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Metadatastores$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`. + * Retrieves a specific Execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$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$Metadatastores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; options = {}; } @@ -63214,11 +64477,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -63229,71 +64489,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists Executions in the MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$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$Metadatastores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; options = {}; } @@ -63306,87 +64572,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/executions').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 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 stored Execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$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$Metadatastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; options = {}; } @@ -63400,7 +64671,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -63411,75 +64682,77 @@ export namespace aiplatform_v1beta1 { 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`. + * Purges Executions. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Metadatastores$Operations$List, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - list( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$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$Metadatastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; options = {}; } @@ -63492,92 +64765,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/executions:purge').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( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting 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. */ - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + queryExecutionInputsAndOutputs( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + ): GaxiosPromise; + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, - callback: BodyResponseCallback + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + queryExecutionInputsAndOutputs( + callback: BodyResponseCallback ): void; - wait( + queryExecutionInputsAndOutputs( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; options = {}; } @@ -63590,313 +64861,142 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1beta1/{+execution}:queryExecutionInputsAndOutputs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['execution'], + pathParams: ['execution'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ - name?: string; + execution?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1AddExecutionEventsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) + */ + executionId?: string; + /** + * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Execution; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + extends StandardParameters { + /** + * Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + */ + etag?: string; + /** + * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List extends StandardParameters { /** - * The standard list filter. + * Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. */ filter?: string; /** - * The name of the operation's parent resource. + * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) */ pageToken?: string; + /** + * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * If set to true, and the Execution is not found, a new Execution is created. */ - name?: string; + allowMissing?: boolean; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Output only. The resource name of the Execution. */ - timeout?: string; - } - - export class Resource$Projects$Locations$Migratableresources { - context: APIRequestContext; - operations: Resource$Projects$Locations$Migratableresources$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Migratableresources$Operations( - this.context - ); - } - + name?: string; /** - * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Optional. A FieldMask indicating which fields should be updated. */ - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, - options: StreamMethodOptions - ): GaxiosPromise; - batchMigrate( - params?: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, - options?: MethodOptions - ): GaxiosPromise; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, - callback: BodyResponseCallback - ): void; - batchMigrate( - callback: BodyResponseCallback - ): void; - batchMigrate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Batchmigrate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/migratableResources:batchMigrate' - ).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); - } - } + updateMask?: string; /** - * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given 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. + * Request body metadata */ - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - options: StreamMethodOptions - ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Migratableresources$Search, - options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - callback: BodyResponseCallback - ): void; - search( - callback: BodyResponseCallback - ): void; - search( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Search - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Migratableresources$Search; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/migratableResources:search' - ).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 - ); - } - } + requestBody?: Schema$GoogleCloudAiplatformV1beta1Execution; } - - export interface Params$Resource$Projects$Locations$Migratableresources$Batchmigrate + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge extends StandardParameters { /** - * Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` + * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeExecutionsRequest; } - export interface Params$Resource$Projects$Locations$Migratableresources$Search + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs extends StandardParameters { /** - * Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest; + execution?: string; } - export class Resource$Projects$Locations$Migratableresources$Operations { + export class Resource$Projects$Locations$Metadatastores$Executions$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -63911,31 +65011,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63951,13 +65051,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; options = {}; } @@ -64003,31 +65103,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Delete + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64043,13 +65143,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; options = {}; } @@ -64092,27 +65192,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -64120,7 +65220,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64136,13 +65236,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; options = {}; } @@ -64185,27 +65285,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, callback: BodyResponseCallback ): void; list( @@ -64213,7 +65313,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$List + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64229,13 +65329,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; options = {}; } @@ -64283,27 +65383,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -64311,7 +65411,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64327,13 +65427,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; options = {}; } @@ -64371,28 +65471,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$List + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List extends StandardParameters { /** * The standard list filter. @@ -64411,7 +65511,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Wait + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -64423,19 +65523,14 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs { + export class Resource$Projects$Locations$Metadatastores$Metadataschemas { context: APIRequestContext; - operations: Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations( - this.context - ); } /** - * Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. + * Creates a MetadataSchema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -64443,57 +65538,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$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$Modeldeploymentmonitoringjobs$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; options = {}; } @@ -64506,9 +65601,10 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+parent}/modelDeploymentMonitoringJobs' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/metadataSchemas').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -64520,77 +65616,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a ModelDeploymentMonitoringJob. + * Retrieves a specific MetadataSchema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Modeldeploymentmonitoringjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$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$Modeldeploymentmonitoringjobs$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; options = {}; } @@ -64604,7 +65700,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -64615,75 +65711,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a ModelDeploymentMonitoringJob. + * Lists MetadataSchemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Modeldeploymentmonitoringjobs$Get, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$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$Modeldeploymentmonitoringjobs$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; options = {}; } @@ -64696,89 +65794,138 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/metadataSchemas').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$Metadatastores$Metadataschemas$Create + extends StandardParameters { /** - * Lists ModelDeploymentMonitoringJobs in a Location. + * The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) + */ + metadataSchemaId?: string; + /** + * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1MetadataSchema; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + extends StandardParameters { + /** + * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List + extends StandardParameters { + /** + * A query to filter available MetadataSchemas for matching results. + */ + filter?: string; + /** + * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Metadatastores$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$Modeldeploymentmonitoringjobs$List, + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$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$Modeldeploymentmonitoringjobs$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; options = {}; } @@ -64791,91 +65938,86 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+parent}/modelDeploymentMonitoringJobs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a ModelDeploymentMonitoringJob. + * 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. */ - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$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$Modeldeploymentmonitoringjobs$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; options = {}; } @@ -64889,7 +66031,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -64900,71 +66042,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - pause( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + callback: BodyResponseCallback ): void; - pause(callback: BodyResponseCallback): void; - pause( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$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$Modeldeploymentmonitoringjobs$Pause; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; options = {}; } @@ -64977,11 +66123,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:pause').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -64992,71 +66135,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - resume( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + callback: BodyResponseCallback ): void; - resume(callback: BodyResponseCallback): void; - resume( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$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$Modeldeploymentmonitoringjobs$Resume; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; options = {}; } @@ -65069,11 +66216,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:resume').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -65084,75 +66231,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Searches Model Monitoring Statistics generated within a given time window. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - searchModelDeploymentMonitoringStatsAnomalies( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; options = {}; } @@ -65165,65 +66314,62 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['modelDeploymentMonitoringJob'], - pathParams: ['modelDeploymentMonitoringJob'], + 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$Modeldeploymentmonitoringjobs$Create + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel extends StandardParameters { /** - * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob; + name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get extends StandardParameters { /** - * Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ @@ -65232,69 +66378,249 @@ export namespace aiplatform_v1beta1 { * The standard list page token. */ pageToken?: string; - /** - * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait extends StandardParameters { /** - * Output only. Resource name of a ModelDeploymentMonitoringJob. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob 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. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob; + timeout?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause - extends StandardParameters { + + export class Resource$Projects$Locations$Migratableresources { + context: APIRequestContext; + operations: Resource$Projects$Locations$Migratableresources$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Migratableresources$Operations( + this.context + ); + } + /** - * Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options: StreamMethodOptions + ): GaxiosPromise; + batchMigrate( + params?: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options?: MethodOptions + ): GaxiosPromise; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + callback: BodyResponseCallback + ): void; + batchMigrate( + callback: BodyResponseCallback + ): void; + batchMigrate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Batchmigrate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/migratableResources:batchMigrate' + ).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); + } + } /** - * Request body metadata + * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given 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. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Projects$Locations$Migratableresources$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/migratableResources:search' + ).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$Modeldeploymentmonitoringjobs$Resume + + export interface Params$Resource$Projects$Locations$Migratableresources$Batchmigrate extends StandardParameters { /** - * Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies + export interface Params$Resource$Projects$Locations$Migratableresources$Search extends StandardParameters { /** - * Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` */ - modelDeploymentMonitoringJob?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest; } - export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations { + export class Resource$Projects$Locations$Migratableresources$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -65309,31 +66635,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65349,13 +66675,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; options = {}; } @@ -65401,31 +66727,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete + | Params$Resource$Projects$Locations$Migratableresources$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65441,13 +66767,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; options = {}; } @@ -65490,27 +66816,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -65518,7 +66844,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get + | Params$Resource$Projects$Locations$Migratableresources$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65534,13 +66860,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; options = {}; } @@ -65583,27 +66909,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, callback: BodyResponseCallback ): void; list( @@ -65611,7 +66937,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List + | Params$Resource$Projects$Locations$Migratableresources$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65627,13 +66953,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$List; options = {}; } @@ -65681,27 +67007,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -65709,7 +67035,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait + | Params$Resource$Projects$Locations$Migratableresources$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65725,13 +67051,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; options = {}; } @@ -65769,28 +67095,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$List extends StandardParameters { /** * The standard list filter. @@ -65809,7 +67135,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -65821,22 +67147,19 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Modelmonitors { + export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs { context: APIRequestContext; - modelMonitoringJobs: Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs; - operations: Resource$Projects$Locations$Modelmonitors$Operations; + operations: Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.modelMonitoringJobs = - new Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs( + this.operations = + new Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations( this.context ); - this.operations = - new Resource$Projects$Locations$Modelmonitors$Operations(this.context); } /** - * Creates a ModelMonitor. + * Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -65844,56 +67167,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Modelmonitors$Create, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Modelmonitors$Create, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Modelmonitors$Create, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Modelmonitors$Create, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Modelmonitors$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$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$Modelmonitors$Create; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Modelmonitors$Create; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; options = {}; } @@ -65906,10 +67230,9 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/modelMonitors').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+parent}/modelDeploymentMonitoringJobs' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -65921,17 +67244,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a ModelMonitor. + * Deletes a ModelDeploymentMonitoringJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -65939,27 +67264,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Modelmonitors$Delete, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, callback: BodyResponseCallback ): void; delete( @@ -65967,7 +67292,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Delete + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65983,12 +67308,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modelmonitors$Delete; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Modelmonitors$Delete; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; options = {}; } @@ -66023,7 +67349,7 @@ export namespace aiplatform_v1beta1 { } /** - * Gets a ModelMonitor. + * Gets a ModelDeploymentMonitoringJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -66031,56 +67357,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Modelmonitors$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Modelmonitors$Get, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$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$Modelmonitors$Get; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Modelmonitors$Get; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; options = {}; } @@ -66105,19 +67432,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists ModelMonitors in a Location. + * Lists ModelDeploymentMonitoringJobs in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -66125,56 +67452,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Modelmonitors$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Modelmonitors$List, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Modelmonitors$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modelmonitors$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modelmonitors$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$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$Modelmonitors$List; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Modelmonitors$List; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; options = {}; } @@ -66187,10 +67515,9 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/modelMonitors').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+parent}/modelDeploymentMonitoringJobs' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -66202,19 +67529,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ModelMonitor. + * Updates a ModelDeploymentMonitoringJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -66222,27 +67549,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Modelmonitors$Patch, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Modelmonitors$Patch, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Modelmonitors$Patch, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Modelmonitors$Patch, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Modelmonitors$Patch, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, callback: BodyResponseCallback ): void; patch( @@ -66250,7 +67577,7 @@ export namespace aiplatform_v1beta1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Patch + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66266,12 +67593,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modelmonitors$Patch; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Modelmonitors$Patch; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; options = {}; } @@ -66306,65 +67634,153 @@ export namespace aiplatform_v1beta1 { } /** - * Returns the Model Monitoring alerts. + * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchModelMonitoringAlerts( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, options: StreamMethodOptions ): GaxiosPromise; - searchModelMonitoringAlerts( - params?: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, + pause( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, options?: MethodOptions - ): GaxiosPromise; - searchModelMonitoringAlerts( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, + ): GaxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchModelMonitoringAlerts( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, - options: + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + callback: BodyResponseCallback + ): void; + pause(callback: BodyResponseCallback): void; + pause( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + 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}:pause').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options: StreamMethodOptions + ): GaxiosPromise; + resume( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options?: MethodOptions + ): GaxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchModelMonitoringAlerts( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchModelMonitoringAlerts( - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + callback: BodyResponseCallback ): void; - searchModelMonitoringAlerts( + resume(callback: BodyResponseCallback): void; + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; options = {}; } @@ -66377,91 +67793,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+modelMonitor}:searchModelMonitoringAlerts' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}:resume').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['modelMonitor'], - pathParams: ['modelMonitor'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Searches Model Monitoring Stats generated within a given time window. + * Searches Model Monitoring Statistics generated within a given time window. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchModelMonitoringStats( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options: StreamMethodOptions ): GaxiosPromise; - searchModelMonitoringStats( - params?: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, + searchModelDeploymentMonitoringStatsAnomalies( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options?: MethodOptions - ): GaxiosPromise; - searchModelMonitoringStats( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, + ): GaxiosPromise; + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchModelMonitoringStats( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchModelMonitoringStats( - params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, - callback: BodyResponseCallback + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + callback: BodyResponseCallback ): void; - searchModelMonitoringStats( - callback: BodyResponseCallback + searchModelDeploymentMonitoringStatsAnomalies( + callback: BodyResponseCallback ): void; - searchModelMonitoringStats( + searchModelDeploymentMonitoringStatsAnomalies( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; options = {}; } @@ -66475,7 +67890,8 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: ( - rootUrl + '/v1beta1/{+modelMonitor}:searchModelMonitoringStats' + rootUrl + + '/v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -66483,61 +67899,53 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['modelMonitor'], - pathParams: ['modelMonitor'], + requiredParams: ['modelDeploymentMonitoringJob'], + pathParams: ['modelDeploymentMonitoringJob'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Modelmonitors$Create + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create extends StandardParameters { /** - * Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. - */ - modelMonitorId?: string; - /** - * Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project\}/locations/{location\}` + * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelMonitor; + requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Delete + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete extends StandardParameters { /** - * Optional. Force delete the model monitor with schedules. - */ - force?: boolean; - /** - * Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project\}/locations/{location\}/modelMonitords/{model_monitor\}` + * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Get + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get extends StandardParameters { /** - * Required. The name of the ModelMonitor resource. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + * Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Modelmonitors$List + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List extends StandardParameters { /** - * The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` */ filter?: string; /** @@ -66549,121 +67957,129 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project\}/locations/{location\}` + * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** - * Mask specifying which fields to read. + * Mask specifying which fields to read */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Patch + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch extends StandardParameters { /** - * Immutable. Resource name of the ModelMonitor. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}`. + * Output only. Resource name of a ModelDeploymentMonitoringJob. */ name?: string; /** - * Required. Mask specifying which fields to update. + * Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob 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. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelMonitor; + requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause extends StandardParameters { /** - * Required. ModelMonitor resource name. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + * Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ - modelMonitor?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume extends StandardParameters { /** - * Required. ModelMonitor resource name. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + * Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ - modelMonitor?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies + extends StandardParameters { + /** + * Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + */ + modelDeploymentMonitoringJob?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest; } - export class Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs { + export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a ModelMonitoringJob. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, + cancel( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$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$Modelmonitors$Modelmonitoringjobs$Create; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; options = {}; } @@ -66676,7 +68092,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/modelMonitoringJobs').replace( + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), @@ -66686,24 +68102,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a ModelMonitoringJob. + * 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`. @@ -66711,57 +68125,53 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$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$Modelmonitors$Modelmonitoringjobs$Delete; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; options = {}; } @@ -66786,17 +68196,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a ModelMonitoringJob. + * 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`. @@ -66804,57 +68214,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$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$Modelmonitors$Modelmonitoringjobs$Get; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; options = {}; } @@ -66879,19 +68289,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id\}/locations/{location\}/moodelMonitors/-/modelMonitoringJobs` + * 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`. @@ -66899,57 +68307,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$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$Modelmonitors$Modelmonitoringjobs$List; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; options = {}; } @@ -66962,7 +68370,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/modelMonitoringJobs').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -66972,59 +68380,150 @@ export namespace aiplatform_v1beta1 { 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$Modelmonitors$Modelmonitoringjobs$Create - extends StandardParameters { /** - * Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. - */ - modelMonitoringJobId?: string; - /** - * Required. The parent of the ModelMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelMoniitors/{model_monitor\}` + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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; + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + 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}:wait').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$Modeldeploymentmonitoringjobs$Operations$Cancel + extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelMonitoringJob; + name?: string; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}/modelMonitoringJobs/{model_monitoring_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get extends StandardParameters { /** - * Required. The resource name of the ModelMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}/modelMonitoringJobs/{model_monitoring_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List extends StandardParameters { /** - * The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ @@ -67033,78 +68532,92 @@ export namespace aiplatform_v1beta1 { * The standard list page token. */ pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait + extends StandardParameters { /** - * Required. The parent of the ModelMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + * The name of the operation resource to wait on. */ - parent?: string; + name?: string; /** - * Mask specifying which fields to read + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - readMask?: string; + timeout?: string; } - export class Resource$Projects$Locations$Modelmonitors$Operations { + export class Resource$Projects$Locations$Modelmonitors { context: APIRequestContext; + modelMonitoringJobs: Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs; + operations: Resource$Projects$Locations$Modelmonitors$Operations; constructor(context: APIRequestContext) { this.context = context; + this.modelMonitoringJobs = + new Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs( + this.context + ); + this.operations = + new Resource$Projects$Locations$Modelmonitors$Operations(this.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 ModelMonitor. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Modelmonitors$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Modelmonitors$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$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$Modelmonitors$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Modelmonitors$Create; options = {}; } @@ -67117,7 +68630,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/modelMonitors').replace( /([^:]\/)\/+/g, '$1' ), @@ -67127,22 +68640,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a ModelMonitor. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -67150,53 +68663,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, + params: Params$Resource$Projects$Locations$Modelmonitors$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, + params?: Params$Resource$Projects$Locations$Modelmonitors$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, + params: Params$Resource$Projects$Locations$Modelmonitors$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modelmonitors$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modelmonitors$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$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$Modelmonitors$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Modelmonitors$Delete; options = {}; } @@ -67221,17 +68737,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a ModelMonitor. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -67239,57 +68755,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, + params: Params$Resource$Projects$Locations$Modelmonitors$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, + params?: Params$Resource$Projects$Locations$Modelmonitors$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, + params: Params$Resource$Projects$Locations$Modelmonitors$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, + params: Params$Resource$Projects$Locations$Modelmonitors$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modelmonitors$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$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$Modelmonitors$Operations$Get; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Modelmonitors$Get; options = {}; } @@ -67314,17 +68829,19 @@ export namespace aiplatform_v1beta1 { 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 ModelMonitors in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -67332,57 +68849,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, + params: Params$Resource$Projects$Locations$Modelmonitors$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, + params?: Params$Resource$Projects$Locations$Modelmonitors$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, + params: Params$Resource$Projects$Locations$Modelmonitors$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, + params: Params$Resource$Projects$Locations$Modelmonitors$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modelmonitors$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$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$Modelmonitors$Operations$List; + {}) as Params$Resource$Projects$Locations$Modelmonitors$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$List; + params = {} as Params$Resource$Projects$Locations$Modelmonitors$List; options = {}; } @@ -67395,7 +68911,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/modelMonitors').replace( /([^:]\/)\/+/g, '$1' ), @@ -67405,60 +68921,60 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a ModelMonitor. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Modelmonitors$Patch, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Modelmonitors$Patch, options?: MethodOptions ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Modelmonitors$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Modelmonitors$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Modelmonitors$Patch, callback: BodyResponseCallback ): void; - wait( + patch( callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait + | Params$Resource$Projects$Locations$Modelmonitors$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67474,13 +68990,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Modelmonitors$Patch; options = {}; } @@ -67493,11 +69008,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -67516,133 +69028,67 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modelmonitors$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 interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Models { - context: APIRequestContext; - evaluations: Resource$Projects$Locations$Models$Evaluations; - operations: Resource$Projects$Locations$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.evaluations = new Resource$Projects$Locations$Models$Evaluations( - this.context - ); - this.operations = new Resource$Projects$Locations$Models$Operations( - this.context - ); - } /** - * Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. + * Returns the Model Monitoring alerts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + searchModelMonitoringAlerts( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, options: StreamMethodOptions ): GaxiosPromise; - copy( - params?: Params$Resource$Projects$Locations$Models$Copy, + searchModelMonitoringAlerts( + params?: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, options?: MethodOptions - ): GaxiosPromise; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + ): GaxiosPromise; + searchModelMonitoringAlerts( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + searchModelMonitoringAlerts( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, - callback: BodyResponseCallback + searchModelMonitoringAlerts( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts, + callback: BodyResponseCallback ): void; - copy( - callback: BodyResponseCallback + searchModelMonitoringAlerts( + callback: BodyResponseCallback ): void; - copy( + searchModelMonitoringAlerts( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Copy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Copy; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Copy; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts; options = {}; } @@ -67655,89 +69101,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/models:copy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+modelMonitor}:searchModelMonitoringAlerts' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['modelMonitor'], + pathParams: ['modelMonitor'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field. + * Searches Model Monitoring Stats generated within a given time window. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Delete, + searchModelMonitoringStats( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Models$Delete, + searchModelMonitoringStats( + params?: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, + ): GaxiosPromise; + searchModelMonitoringStats( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, + searchModelMonitoringStats( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, - callback: BodyResponseCallback + searchModelMonitoringStats( + params: Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + searchModelMonitoringStats( + callback: BodyResponseCallback ): void; - delete( + searchModelMonitoringStats( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Delete; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Delete; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats; options = {}; } @@ -67750,86 +69198,196 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta1/{+modelMonitor}:searchModelMonitoringStats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['modelMonitor'], + pathParams: ['modelMonitor'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Create + extends StandardParameters { /** - * Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead. + * Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. + */ + modelMonitorId?: string; + /** + * Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelMonitor; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Delete + extends StandardParameters { + /** + * Optional. Force delete the model monitor with schedules. + */ + force?: boolean; + /** + * Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project\}/locations/{location\}/modelMonitords/{model_monitor\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Get + extends StandardParameters { + /** + * Required. The name of the ModelMonitor resource. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$List + extends StandardParameters { + /** + * The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the ModelMonitor. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}`. + */ + name?: string; + /** + * Required. Mask specifying which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelMonitor; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringalerts + extends StandardParameters { + /** + * Required. ModelMonitor resource name. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + */ + modelMonitor?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Searchmodelmonitoringstats + extends StandardParameters { + /** + * Required. ModelMonitor resource name. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + */ + modelMonitor?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest; + } + + export class Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a ModelMonitoringJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, options: StreamMethodOptions ): GaxiosPromise; - deleteVersion( - params?: Params$Resource$Projects$Locations$Models$Deleteversion, + create( + params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, options?: MethodOptions - ): GaxiosPromise; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create, + callback: BodyResponseCallback ): void; - deleteVersion( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - deleteVersion( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Deleteversion - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$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$Models$Deleteversion; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Deleteversion; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create; options = {}; } @@ -67842,68 +69400,70 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:deleteVersion').replace( + url: (rootUrl + '/v1beta1/{+parent}/modelMonitoringJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'DELETE', + 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 + ); } } /** - * Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. + * Deletes a ModelMonitoringJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - export( - params: Params$Resource$Projects$Locations$Models$Export, + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, options: StreamMethodOptions ): GaxiosPromise; - export( - params?: Params$Resource$Projects$Locations$Models$Export, + delete( + params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, options?: MethodOptions ): GaxiosPromise; - export( - params: Params$Resource$Projects$Locations$Models$Export, + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Models$Export, + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Models$Export, + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete, callback: BodyResponseCallback ): void; - export( + delete( callback: BodyResponseCallback ): void; - export( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Export + | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67919,12 +69479,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Export; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Export; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete; options = {}; } @@ -67937,11 +69498,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:export').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -67962,7 +69520,7 @@ export namespace aiplatform_v1beta1 { } /** - * Gets a Model. + * Gets a ModelMonitoringJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -67970,56 +69528,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Models$Get, + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Models$Get, + params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Models$Get, + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Get, + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$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$Models$Get; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Get; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get; options = {}; } @@ -68044,74 +69603,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id\}/locations/{location\}/moodelMonitors/-/modelMonitoringJobs` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Models$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$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$Models$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List; options = {}; } @@ -68124,89 +69686,149 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/modelMonitoringJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Create + extends StandardParameters { /** - * Lists Models in a Location. + * Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. + */ + modelMonitoringJobId?: string; + /** + * Required. The parent of the ModelMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelMoniitors/{model_monitor\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ModelMonitoringJob; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Delete + extends StandardParameters { + /** + * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}/modelMonitoringJobs/{model_monitoring_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$Get + extends StandardParameters { + /** + * Required. The resource name of the ModelMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}/modelMonitoringJobs/{model_monitoring_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Modelmonitoringjobs$List + extends StandardParameters { + /** + * The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The parent of the ModelMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelMonitors/{model_monitor\}` + */ + parent?: string; + /** + * Mask specifying which fields to read + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Modelmonitors$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$Models$List, + cancel( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Models$List, + cancel( + params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Models$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Models$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$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$Models$List; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$List; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel; options = {}; } @@ -68219,92 +69841,86 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/models').replace( + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists checkpoints of the specified model version. + * 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. */ - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - listCheckpoints( - params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, + delete( + params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, 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 + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listCheckpoints( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete, + callback: BodyResponseCallback ): void; - listCheckpoints( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Listcheckpoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$Operations$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$Models$Listcheckpoints; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; + {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete; options = {}; } @@ -68317,11 +69933,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:listCheckpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -68332,76 +69945,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists versions of the specified model. + * 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. */ - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + get( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - listVersions( - params?: Params$Resource$Projects$Locations$Models$Listversions, + get( + params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + get( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Get, + callback: BodyResponseCallback ): void; - listVersions( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - listVersions( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Listversions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$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$Models$Listversions; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Listversions; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Get; options = {}; } @@ -68414,10 +70026,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:listVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -68429,77 +70038,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Merges a set of aliases for a Model version. + * 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. */ - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - mergeVersionAliases( - params?: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + list( + params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, options?: MethodOptions - ): GaxiosPromise; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$List, + callback: BodyResponseCallback ): void; - mergeVersionAliases( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - mergeVersionAliases( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Mergeversionaliases - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$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$Models$Mergeversionaliases; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Mergeversionaliases; + {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$List; options = {}; } @@ -68512,11 +70119,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:mergeVersionAliases').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -68527,76 +70134,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Model. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Patch, + wait( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Models$Patch, + wait( + params?: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, + wait( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Patch; + {}) as Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Patch; + params = + {} as Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait; options = {}; } @@ -68609,8 +70217,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -68621,74 +70232,141 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modelmonitors$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 interface Params$Resource$Projects$Locations$Modelmonitors$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Models { + context: APIRequestContext; + evaluations: Resource$Projects$Locations$Models$Evaluations; + operations: Resource$Projects$Locations$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.evaluations = new Resource$Projects$Locations$Models$Evaluations( + this.context + ); + this.operations = new Resource$Projects$Locations$Models$Operations( + this.context + ); + } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Setiampolicy, + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Models$Setiampolicy, + copy( + params?: Params$Resource$Projects$Locations$Models$Copy, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, + ): GaxiosPromise; + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + copy( + params: Params$Resource$Projects$Locations$Models$Copy, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, - callback: BodyResponseCallback + copy( + params: Params$Resource$Projects$Locations$Models$Copy, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + copy( + callback: BodyResponseCallback ): void; - setIamPolicy( + copy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Copy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Models$Copy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Models$Copy; options = {}; } @@ -68701,7 +70379,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/models:copy').replace( /([^:]\/)\/+/g, '$1' ), @@ -68711,80 +70389,79 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models 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. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Models$Delete, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Models$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Models$Delete, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Models$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Models$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Models$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - testIamPermissions( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$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$Models$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Models$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Models$Delete; options = {}; } @@ -68797,70 +70474,65 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Incrementally update the dataset used for an examples model. + * Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, options: StreamMethodOptions ): GaxiosPromise; - updateExplanationDataset( - params?: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + deleteVersion( + params?: Params$Resource$Projects$Locations$Models$Deleteversion, options?: MethodOptions ): GaxiosPromise; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, callback: BodyResponseCallback ): void; - updateExplanationDataset( + deleteVersion( callback: BodyResponseCallback ): void; - updateExplanationDataset( + deleteVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Updateexplanationdataset + | Params$Resource$Projects$Locations$Models$Deleteversion | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68876,13 +70548,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; + {}) as Params$Resource$Projects$Locations$Models$Deleteversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; + params = {} as Params$Resource$Projects$Locations$Models$Deleteversion; options = {}; } @@ -68895,17 +70566,18 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+model}:updateExplanationDataset' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}:deleteVersion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -68919,43 +70591,43 @@ export namespace aiplatform_v1beta1 { } /** - * Uploads a Model artifact into Vertex AI. + * Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Projects$Locations$Models$Upload, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: StreamMethodOptions ): GaxiosPromise; - upload( - params?: Params$Resource$Projects$Locations$Models$Upload, + export( + params?: Params$Resource$Projects$Locations$Models$Export, options?: MethodOptions ): GaxiosPromise; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + export( + params: Params$Resource$Projects$Locations$Models$Export, callback: BodyResponseCallback ): void; - upload( + export( callback: BodyResponseCallback ): void; - upload( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Upload + | Params$Resource$Projects$Locations$Models$Export | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68971,12 +70643,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Upload; + {}) as Params$Resource$Projects$Locations$Models$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Upload; + params = {} as Params$Resource$Projects$Locations$Models$Export; options = {}; } @@ -68989,7 +70661,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/models:upload').replace( + url: (rootUrl + '/v1beta1/{+name}:export').replace( /([^:]\/)\/+/g, '$1' ), @@ -68999,8 +70671,8 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -69012,222 +70684,9 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Models$Copy - extends StandardParameters { - /** - * Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1CopyModelRequest; - } - export interface Params$Resource$Projects$Locations$Models$Delete - extends StandardParameters { - /** - * Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Deleteversion - extends StandardParameters { - /** - * Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Export - extends StandardParameters { - /** - * Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ExportModelRequest; - } - export interface Params$Resource$Projects$Locations$Models$Get - extends StandardParameters { - /** - * Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. 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 "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$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$Models$List - extends StandardParameters { - /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - 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 { - /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` - */ - filter?: string; - /** - * Required. The name of the model to list versions for. - */ - name?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. - */ - pageToken?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Models$Mergeversionaliases - extends StandardParameters { - /** - * Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest; - } - export interface Params$Resource$Projects$Locations$Models$Patch - extends StandardParameters { - /** - * The resource name of the Model. - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Model; - } - export interface Params$Resource$Projects$Locations$Models$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$Models$Testiampermissions - extends StandardParameters { - /** - * 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[]; - /** - * 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; - } - export interface Params$Resource$Projects$Locations$Models$Updateexplanationdataset - extends StandardParameters { - /** - * Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest; - } - export interface Params$Resource$Projects$Locations$Models$Upload - extends StandardParameters { - /** - * Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1UploadModelRequest; - } - - export class Resource$Projects$Locations$Models$Evaluations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Models$Evaluations$Operations; - slices: Resource$Projects$Locations$Models$Evaluations$Slices; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Models$Evaluations$Operations( - this.context - ); - this.slices = new Resource$Projects$Locations$Models$Evaluations$Slices( - this.context - ); - } /** - * Gets a ModelEvaluation. + * Gets a Model. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -69235,57 +70694,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + params: Params$Resource$Projects$Locations$Models$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Get, + params?: Params$Resource$Projects$Locations$Models$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + params: Params$Resource$Projects$Locations$Models$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + params: Params$Resource$Projects$Locations$Models$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Models$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$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$Models$Evaluations$Get; + {}) as Params$Resource$Projects$Locations$Models$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Get; + params = {} as Params$Resource$Projects$Locations$Models$Get; options = {}; } @@ -69310,77 +70768,74 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Imports an externally generated ModelEvaluation. + * 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. */ - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Import, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Models$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - import( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Import; + {}) as Params$Resource$Projects$Locations$Models$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Import; + params = {} as Params$Resource$Projects$Locations$Models$Getiampolicy; options = {}; } @@ -69393,7 +70848,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/evaluations:import').replace( + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -69403,24 +70858,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelEvaluations in a Model. + * Lists Models in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -69428,57 +70881,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + params: Params$Resource$Projects$Locations$Models$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$List, + params?: Params$Resource$Projects$Locations$Models$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + params: Params$Resource$Projects$Locations$Models$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + params: Params$Resource$Projects$Locations$Models$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Models$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$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$Models$Evaluations$List; + {}) as Params$Resource$Projects$Locations$Models$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$List; + params = {} as Params$Resource$Projects$Locations$Models$List; options = {}; } @@ -69491,7 +70943,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/evaluations').replace( + url: (rootUrl + '/v1beta1/{+parent}/models').replace( /([^:]\/)\/+/g, '$1' ), @@ -69506,123 +70958,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Models$Evaluations$Get - extends StandardParameters { - /** - * Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Import - extends StandardParameters { - /** - * Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. - */ - pageToken?: string; - /** - * Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Models$Evaluations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Lists 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. */ - cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + listCheckpoints( + params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + ): GaxiosPromise; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, - callback: BodyResponseCallback + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + listCheckpoints( + callback: BodyResponseCallback + ): void; + listCheckpoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Listcheckpoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; + {}) 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$Evaluations$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; options = {}; } @@ -69635,11 +71041,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+name}:listCheckpoints').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -69650,71 +71056,76 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists versions of the specified model. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + listVersions( + params?: Params$Resource$Projects$Locations$Models$Listversions, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + ): GaxiosPromise; + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, - callback: BodyResponseCallback + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + listVersions( + callback: BodyResponseCallback + ): void; + listVersions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Listversions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Models$Listversions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Models$Listversions; options = {}; } @@ -69727,8 +71138,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+name}:listVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -69739,75 +71153,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Merges a set of aliases for a 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. */ - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + mergeVersionAliases( + params?: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + ): GaxiosPromise; + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, - callback: BodyResponseCallback + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + mergeVersionAliases( + callback: BodyResponseCallback ): void; - get( + mergeVersionAliases( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Mergeversionaliases + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Models$Mergeversionaliases; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + {} as Params$Resource$Projects$Locations$Models$Mergeversionaliases; options = {}; } @@ -69820,8 +71236,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:mergeVersionAliases').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -69832,75 +71251,76 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a Model. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Models$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Models$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$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$Models$Evaluations$Operations$List; + {}) as Params$Resource$Projects$Locations$Models$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Models$Patch; options = {}; } @@ -69913,11 +71333,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -69928,77 +71345,74 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * 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. */ - wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Models$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - wait( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Models$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Models$Setiampolicy; options = {}; } @@ -70011,7 +71425,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -70021,139 +71435,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$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 interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Models$Evaluations$Slices { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports a list of externally generated EvaluatedAnnotations. + * 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. */ - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - batchImport( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Models$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, + callback: BodyResponseCallback ): void; - batchImport( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - batchImport( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; + {}) as Params$Resource$Projects$Locations$Models$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; + {} as Params$Resource$Projects$Locations$Models$Testiampermissions; options = {}; } @@ -70166,7 +71521,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}:batchImport').replace( + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), @@ -70176,82 +71531,82 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a ModelEvaluationSlice. + * Incrementally update the dataset used for an examples model. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + updateExplanationDataset( + params?: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + ): GaxiosPromise; + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, - callback: BodyResponseCallback + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + updateExplanationDataset( + callback: BodyResponseCallback ): void; - get( + updateExplanationDataset( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Updateexplanationdataset + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + {}) as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + {} as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; options = {}; } @@ -70264,89 +71619,88 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta1/{+model}:updateExplanationDataset' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelEvaluationSlices in a ModelEvaluation. + * Uploads a Model artifact into Vertex AI. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Evaluations$Slices$List, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + upload( + params?: Params$Resource$Projects$Locations$Models$Upload, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, - callback: BodyResponseCallback + upload( + params: Params$Resource$Projects$Locations$Models$Upload, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + upload( + callback: BodyResponseCallback ): void; - list( + upload( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Upload + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + {}) as Params$Resource$Projects$Locations$Models$Upload; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + params = {} as Params$Resource$Projects$Locations$Models$Upload; options = {}; } @@ -70359,11 +71713,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/slices').replace( + url: (rootUrl + '/v1beta1/{+parent}/models:upload').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -70374,123 +71728,2794 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport + export interface Params$Resource$Projects$Locations$Models$Copy extends StandardParameters { /** - * Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + * Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1CopyModelRequest; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get + export interface Params$Resource$Projects$Locations$Models$Delete extends StandardParameters { /** - * Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + * Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$List + export interface Params$Resource$Projects$Locations$Models$Deleteversion extends StandardParameters { /** - * The standard list filter. * `slice.dimension` - for =. + * Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Export + extends StandardParameters { /** - * The standard list page size. + * Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. */ - pageSize?: number; + name?: string; + /** - * The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. + * Request body metadata */ - pageToken?: string; - /** + requestBody?: Schema$GoogleCloudAiplatformV1beta1ExportModelRequest; + } + export interface Params$Resource$Projects$Locations$Models$Get + extends StandardParameters { + /** + * Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. 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 "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$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$Models$List + extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + 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 { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` + */ + filter?: string; + /** + * Required. The name of the model to list versions for. + */ + name?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. + */ + pageToken?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Models$Mergeversionaliases + extends StandardParameters { + /** + * Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest; + } + export interface Params$Resource$Projects$Locations$Models$Patch + extends StandardParameters { + /** + * The resource name of the Model. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Model; + } + export interface Params$Resource$Projects$Locations$Models$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$Models$Testiampermissions + extends StandardParameters { + /** + * 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[]; + /** + * 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; + } + export interface Params$Resource$Projects$Locations$Models$Updateexplanationdataset + extends StandardParameters { + /** + * Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest; + } + export interface Params$Resource$Projects$Locations$Models$Upload + extends StandardParameters { + /** + * Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1UploadModelRequest; + } + + export class Resource$Projects$Locations$Models$Evaluations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Models$Evaluations$Operations; + slices: Resource$Projects$Locations$Models$Evaluations$Slices; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Models$Evaluations$Operations( + this.context + ); + this.slices = new Resource$Projects$Locations$Models$Evaluations$Slices( + this.context + ); + } + + /** + * Gets a ModelEvaluation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Evaluations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Get; + 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: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Imports an externally generated ModelEvaluation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Evaluations$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/evaluations:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists ModelEvaluations in a Model. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Models$Evaluations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/evaluations').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$Models$Evaluations$Get + extends StandardParameters { + /** + * Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Import + extends StandardParameters { + /** + * Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. + */ + pageToken?: string; + /** + * Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Models$Evaluations$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$Models$Evaluations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; + 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}: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$Models$Evaluations$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + 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: '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$Models$Evaluations$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + 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: '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$Models$Evaluations$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; + 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}/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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + 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}:wait').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$Models$Evaluations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$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 interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Models$Evaluations$Slices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports a list of externally generated EvaluatedAnnotations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + options: StreamMethodOptions + ): GaxiosPromise; + batchImport( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + options?: MethodOptions + ): GaxiosPromise; + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + callback: BodyResponseCallback + ): void; + batchImport( + callback: BodyResponseCallback + ): void; + batchImport( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}:batchImport').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a ModelEvaluationSlice. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Evaluations$Slices$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + 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: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists ModelEvaluationSlices in a ModelEvaluation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Evaluations$Slices$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/slices').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$Models$Evaluations$Slices$Batchimport + extends StandardParameters { + /** + * Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get + extends StandardParameters { + /** + * Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$List + extends StandardParameters { + /** + * The standard list filter. * `slice.dimension` - for =. + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. + */ + pageToken?: string; + /** * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` */ - parent?: string; + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Models$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Models$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Operations$Cancel; + 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}: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$Models$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Models$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Models$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Models$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Models$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Operations$Delete; + 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: '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$Models$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Models$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Models$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$Operations$Get; + 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: '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$Models$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Models$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Models$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Models$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Operations$List; + 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}/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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Models$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Operations$Wait; + 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}:wait').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$Models$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$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 interface Params$Resource$Projects$Locations$Models$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Nasjobs { + context: APIRequestContext; + nasTrialDetails: Resource$Projects$Locations$Nasjobs$Nastrialdetails; + constructor(context: APIRequestContext) { + this.context = context; + this.nasTrialDetails = + new Resource$Projects$Locations$Nasjobs$Nastrialdetails(this.context); + } + + /** + * Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `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$Nasjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Cancel; + 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}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a NasJob + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Nasjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/nasJobs').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 NasJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Nasjobs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a NasJob + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Nasjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Get; + 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: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists NasJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Nasjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/nasJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Nasjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1CancelNasJobRequest; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1NasJob; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Delete + extends StandardParameters { + /** + * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Get + extends StandardParameters { + /** + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a NasTrialDetail. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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 + ); + } + } + + /** + * List top NasTrialDetails of a NasJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/nasTrialDetails').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get + extends StandardParameters { + /** + * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List + extends StandardParameters { + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. + */ + pageToken?: string; /** - * Mask specifying which fields to read. + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` */ - readMask?: string; + parent?: string; } - export class Resource$Projects$Locations$Models$Operations { + export class Resource$Projects$Locations$Notebookexecutionjobs { context: APIRequestContext; + operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Notebookexecutionjobs$Operations( + this.context + ); } /** - * 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 NotebookExecutionJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Models$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$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$Models$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; options = {}; } @@ -70503,7 +74528,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/notebookExecutionJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -70513,22 +74538,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a NotebookExecutionJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -70536,53 +74561,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Models$Operations$Delete, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$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$Models$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; options = {}; } @@ -70607,17 +74636,115 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + options: StreamMethodOptions + ): GaxiosPromise; + generateAccessToken( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + options?: MethodOptions + ): GaxiosPromise; + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + callback: BodyResponseCallback + ): void; + generateAccessToken( + callback: BodyResponseCallback + ): void; + generateAccessToken( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken; + 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}:generateAccessToken').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a NotebookExecutionJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -70625,56 +74752,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Models$Operations$Get, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$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$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; options = {}; } @@ -70699,17 +74827,19 @@ export namespace aiplatform_v1beta1 { 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 NotebookExecutionJobs in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -70717,57 +74847,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Models$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; options = {}; } @@ -70780,7 +74910,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/notebookExecutionJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -70790,82 +74920,81 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + reportEvent( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Models$Operations$Wait, + reportEvent( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + ): GaxiosPromise; + reportEvent( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + reportEvent( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, - callback: BodyResponseCallback + reportEvent( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + reportEvent( + callback: BodyResponseCallback ): void; - wait( + reportEvent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent; options = {}; } @@ -70878,7 +75007,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + url: (rootUrl + '/v1beta1/{+name}:reportEvent').replace( /([^:]\/)\/+/g, '$1' ), @@ -70893,79 +75022,112 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Models$Operations$Cancel + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Optional. User specified ID for the NotebookExecutionJob. + */ + notebookExecutionJobId?: string; + /** + * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1NotebookExecutionJob; + } + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + extends StandardParameters { + /** + * Required. The name of the NotebookExecutionJob resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$Delete + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_job\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest; } - export interface Params$Resource$Projects$Locations$Models$Operations$Get + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the NotebookExecutionJob resource. */ name?: string; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$List + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List extends StandardParameters { /** - * The standard list filter. + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. */ pageToken?: string; + /** + * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$Wait + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the NotebookExecutionJob resource. Format: `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_jobs\}` */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1ReportExecutionEventRequest; } - export class Resource$Projects$Locations$Nasjobs { + export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { context: APIRequestContext; - nasTrialDetails: Resource$Projects$Locations$Nasjobs$Nastrialdetails; constructor(context: APIRequestContext) { this.context = context; - this.nasTrialDetails = - new Resource$Projects$Locations$Nasjobs$Nastrialdetails(this.context); } /** - * Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `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`. @@ -70973,31 +75135,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Cancel + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -71013,12 +75175,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Cancel; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; options = {}; } @@ -71056,64 +75219,61 @@ export namespace aiplatform_v1beta1 { } /** - * Creates a NasJob + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Nasjobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$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$Nasjobs$Create; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Create; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; options = {}; } @@ -71125,71 +75285,66 @@ export namespace aiplatform_v1beta1 { const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; const parameters = { options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/nasJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a NasJob. + * 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$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Delete + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -71205,12 +75360,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Delete; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Delete; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; options = {}; } @@ -71224,7 +75380,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -71245,64 +75401,65 @@ export namespace aiplatform_v1beta1 { } /** - * Gets a NasJob + * 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$Nasjobs$Get, + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Nasjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$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$Nasjobs$Get; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Get; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; options = {}; } @@ -71315,7 +75472,10 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -71327,76 +75487,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists NasJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$List; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$List; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; options = {}; } @@ -71409,161 +75570,249 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/nasJobs').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Nasjobs$Cancel + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel extends StandardParameters { /** - * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1CancelNasJobRequest; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1NasJob; } - export interface Params$Resource$Projects$Locations$Nasjobs$Delete + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete extends StandardParameters { /** - * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Nasjobs$Get + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get extends StandardParameters { /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Nasjobs$List + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * 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. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + * The standard list page token. */ pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait + extends StandardParameters { /** - * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + * The name of the operation resource to wait on. */ - parent?: string; + name?: string; /** - * Mask specifying which fields to read. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - readMask?: string; + timeout?: string; } - export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { + export class Resource$Projects$Locations$Notebookruntimes { context: APIRequestContext; + operations: Resource$Projects$Locations$Notebookruntimes$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Notebookruntimes$Operations( + this.context + ); } /** - * Gets a NasTrialDetail. + * Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + assign( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + ): GaxiosPromise; + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - callback: BodyResponseCallback + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + assign( + callback: BodyResponseCallback ): void; - get( + assign( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Assign + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Assign; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Assign; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/notebookRuntimes:assign' + ).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 NotebookRuntime. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookruntimes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookruntimes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Delete; options = {}; } @@ -71577,7 +75826,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -71588,77 +75837,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List top NasTrialDetails of a NasJob. + * Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + generateAccessToken( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + ): GaxiosPromise; + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - callback: BodyResponseCallback + generateAccessToken( + params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + generateAccessToken( + callback: BodyResponseCallback ): void; - list( + generateAccessToken( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken; options = {}; } @@ -71671,127 +75918,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/nasTrialDetails').replace( + url: (rootUrl + '/v1beta1/{+name}:generateAccessToken').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get - extends StandardParameters { - /** - * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List - extends StandardParameters { - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. - */ - pageToken?: string; - /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Notebookexecutionjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookexecutionjobs$Operations( - this.context - ); - } /** - * Creates a NotebookExecutionJob. + * Gets a NotebookRuntime. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + get( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$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$Notebookexecutionjobs$Create; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Get; options = {}; } @@ -71804,90 +76015,88 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/notebookExecutionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a NotebookExecutionJob. + * Lists NotebookRuntimes in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + list( + params?: Params$Resource$Projects$Locations$Notebookruntimes$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$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$Notebookexecutionjobs$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$List; options = {}; } @@ -71900,87 +76109,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/notebookRuntimes').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 + ); } } /** - * Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + reportEvent( + params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, options: StreamMethodOptions ): GaxiosPromise; - generateAccessToken( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + reportEvent( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, options?: MethodOptions - ): GaxiosPromise; - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + ): GaxiosPromise; + reportEvent( + params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, + reportEvent( + params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken, - callback: BodyResponseCallback + reportEvent( + params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, + callback: BodyResponseCallback ): void; - generateAccessToken( - callback: BodyResponseCallback + reportEvent( + callback: BodyResponseCallback ): void; - generateAccessToken( + reportEvent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Reportevent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Reportevent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Reportevent; options = {}; } @@ -71993,7 +76206,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:generateAccessToken').replace( + url: (rootUrl + '/v1beta1/{+name}:reportEvent').replace( /([^:]\/)\/+/g, '$1' ), @@ -72008,77 +76221,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a NotebookExecutionJob. + * Starts a NotebookRuntime. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + start( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Start, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + ): GaxiosPromise; + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, - callback: BodyResponseCallback + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + start( + callback: BodyResponseCallback ): void; - get( + start( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Start + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Start; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Start; options = {}; } @@ -72091,8 +76304,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:start').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -72103,77 +76319,74 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists NotebookExecutionJobs in a Location. + * Stops a NotebookRuntime. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookexecutionjobs$List, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + stop( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + ): GaxiosPromise; + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, - callback: BodyResponseCallback + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + stop( + callback: BodyResponseCallback ): void; - list( + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Stop + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Stop; options = {}; } @@ -72186,91 +76399,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/notebookExecutionJobs').replace( + url: (rootUrl + '/v1beta1/{+name}:stop').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Upgrades a NotebookRuntime. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reportEvent( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: StreamMethodOptions ): GaxiosPromise; - reportEvent( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, + upgrade( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options?: MethodOptions - ): GaxiosPromise; - reportEvent( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, + ): GaxiosPromise; + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reportEvent( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reportEvent( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, - callback: BodyResponseCallback + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + callback: BodyResponseCallback ): void; - reportEvent( - callback: BodyResponseCallback + upgrade( + callback: BodyResponseCallback ): void; - reportEvent( + upgrade( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; options = {}; } @@ -72283,7 +76495,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:reportEvent').replace( + url: (rootUrl + '/v1beta1/{+name}:upgrade').replace( /([^:]\/)\/+/g, '$1' ), @@ -72298,42 +76510,36 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create + export interface Params$Resource$Projects$Locations$Notebookruntimes$Assign extends StandardParameters { /** - * Optional. User specified ID for the NotebookExecutionJob. - */ - notebookExecutionJobId?: string; - /** - * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1NotebookExecutionJob; + requestBody?: Schema$GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + export interface Params$Resource$Projects$Locations$Notebookruntimes$Delete extends StandardParameters { /** - * Required. The name of the NotebookExecutionJob resource to be deleted. + * Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken + export interface Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken extends StandardParameters { /** * Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_job\}` @@ -72345,21 +76551,17 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get + export interface Params$Resource$Projects$Locations$Notebookruntimes$Get extends StandardParameters { /** - * Required. The name of the NotebookExecutionJob resource. + * Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. */ name?: string; - /** - * Optional. The NotebookExecutionJob view. Defaults to BASIC. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List + export interface Params$Resource$Projects$Locations$Notebookruntimes$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` */ filter?: string; /** @@ -72371,32 +76573,68 @@ export namespace aiplatform_v1beta1 { */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. + * Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** - * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * Optional. Mask specifying which fields to read. */ - view?: string; + readMask?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent + export interface Params$Resource$Projects$Locations$Notebookruntimes$Reportevent extends StandardParameters { /** - * Required. The name of the NotebookExecutionJob resource. Format: `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_jobs\}` + * Required. The name of the NotebookRuntime resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ReportExecutionEventRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest; } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Start + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; - export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Stop + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest; + } + + export class Resource$Projects$Locations$Notebookruntimes$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -72411,31 +76649,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72451,13 +76689,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; options = {}; } @@ -72503,31 +76741,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72543,13 +76781,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; options = {}; } @@ -72592,27 +76830,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -72620,7 +76858,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72636,13 +76874,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; options = {}; } @@ -72685,27 +76923,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, callback: BodyResponseCallback ): void; list( @@ -72713,7 +76951,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72729,13 +76967,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; options = {}; } @@ -72783,27 +77021,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -72811,7 +77049,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72827,13 +77065,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; options = {}; } @@ -72871,28 +77109,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$List extends StandardParameters { /** * The standard list filter. @@ -72911,7 +77149,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -72923,55 +77161,55 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Notebookruntimes { + export class Resource$Projects$Locations$Notebookruntimetemplates { context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookruntimes$Operations; + operations: Resource$Projects$Locations$Notebookruntimetemplates$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Notebookruntimes$Operations( + new Resource$Projects$Locations$Notebookruntimetemplates$Operations( this.context ); } /** - * Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. + * Creates a NotebookRuntimeTemplate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: StreamMethodOptions ): GaxiosPromise; - assign( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options?: MethodOptions ): GaxiosPromise; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, callback: BodyResponseCallback ): void; - assign( + create( callback: BodyResponseCallback ): void; - assign( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Assign + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72987,13 +77225,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Assign; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Assign; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; options = {}; } @@ -73007,7 +77245,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: ( - rootUrl + '/v1beta1/{+parent}/notebookRuntimes:assign' + rootUrl + '/v1beta1/{+parent}/notebookRuntimeTemplates' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -73030,7 +77268,7 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes a NotebookRuntime. + * Deletes a NotebookRuntimeTemplate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -73038,27 +77276,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, callback: BodyResponseCallback ): void; delete( @@ -73066,7 +77304,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Delete + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -73082,13 +77320,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; options = {}; } @@ -73123,65 +77361,65 @@ export namespace aiplatform_v1beta1 { } /** - * Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd + * Gets a NotebookRuntimeTemplate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: StreamMethodOptions ): GaxiosPromise; - generateAccessToken( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, + get( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options?: MethodOptions - ): GaxiosPromise; - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateAccessToken( - params: Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + callback: BodyResponseCallback ): void; - generateAccessToken( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - generateAccessToken( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$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$Notebookruntimes$Generateaccesstoken; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; options = {}; } @@ -73194,11 +77432,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:generateAccessToken').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -73209,76 +77444,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a NotebookRuntime. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Get, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - get( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Get; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; options = {}; } @@ -73291,31 +77525,32 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists NotebookRuntimes in a Location. + * Lists NotebookRuntimeTemplates in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -73323,56 +77558,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Notebookruntimes$List, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$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$Notebookruntimes$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$List; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; options = {}; } @@ -73385,10 +77621,9 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/notebookRuntimes').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+parent}/notebookRuntimeTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -73400,76 +77635,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** + * Updates a NotebookRuntimeTemplate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reportEvent( - params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: StreamMethodOptions ): GaxiosPromise; - reportEvent( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, + patch( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options?: MethodOptions - ): GaxiosPromise; - reportEvent( - params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reportEvent( - params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reportEvent( - params: Params$Resource$Projects$Locations$Notebookruntimes$Reportevent, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + callback: BodyResponseCallback ): void; - reportEvent( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - reportEvent( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Reportevent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$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$Notebookruntimes$Reportevent; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Reportevent; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; options = {}; } @@ -73482,11 +77718,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:reportEvent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -73497,172 +77730,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Starts a NotebookRuntime. + * 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. */ - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - start( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Start, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + callback: BodyResponseCallback ): void; - start( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - start( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Start - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Start; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Start; - 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}:start').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); - } - } - - /** - * Stops a NotebookRuntime. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options: StreamMethodOptions - ): GaxiosPromise; - stop( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options?: MethodOptions - ): GaxiosPromise; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - callback: BodyResponseCallback - ): void; - stop( - callback: BodyResponseCallback - ): void; - stop( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Stop - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Stop; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Stop; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; options = {}; } @@ -73675,7 +77811,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:stop').replace( + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -73685,80 +77821,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Upgrades a NotebookRuntime. + * 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. */ - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - upgrade( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + callback: BodyResponseCallback ): void; - upgrade( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - upgrade( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Upgrade - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; options = {}; } @@ -73771,7 +77907,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:upgrade').replace( + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), @@ -73781,63 +77917,68 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Assign + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Create extends StandardParameters { /** - * Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` + * Optional. User specified ID for the notebook runtime template. + */ + notebookRuntimeTemplateId?: string; + /** + * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Delete + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get extends StandardParameters { /** - * Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_job\}` + * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Get + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * 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). */ - name?: string; + '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$Notebookruntimes$List + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` */ filter?: string; /** @@ -73849,11 +77990,11 @@ export namespace aiplatform_v1beta1 { */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. + * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** @@ -73861,56 +78002,47 @@ export namespace aiplatform_v1beta1 { */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Reportevent + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` + * The resource name of the NotebookRuntimeTemplate. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Start - extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed\}"\}` Updatable fields: * `encryption_spec.kms_key_name` */ - name?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Stop + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - name?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest; + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * 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). */ - name?: string; - + permissions?: string[]; /** - * Request body metadata + * 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. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest; + resource?: string; } - export class Resource$Projects$Locations$Notebookruntimes$Operations { + export class Resource$Projects$Locations$Notebookruntimetemplates$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -73925,31 +78057,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -73965,13 +78097,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; options = {}; } @@ -74017,31 +78149,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -74057,13 +78189,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; options = {}; } @@ -74106,27 +78238,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -74134,7 +78266,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -74150,13 +78282,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; options = {}; } @@ -74199,27 +78331,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, callback: BodyResponseCallback ): void; list( @@ -74227,7 +78359,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$List + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -74243,13 +78375,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; options = {}; } @@ -74297,27 +78429,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -74325,7 +78457,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -74341,13 +78473,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; options = {}; } @@ -74385,28 +78517,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$List + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List extends StandardParameters { /** * The standard list filter. @@ -74425,7 +78557,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -74437,358 +78569,67 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Notebookruntimetemplates { + export class Resource$Projects$Locations$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookruntimetemplates$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookruntimetemplates$Operations( - this.context - ); - } - - /** - * Creates a NotebookRuntimeTemplate. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookruntimetemplates$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/notebookRuntimeTemplates' - ).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 NotebookRuntimeTemplate. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookruntimetemplates$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; - 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: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets a NotebookRuntimeTemplate. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookruntimetemplates$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; - 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: '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. + * 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. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - getIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$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$Notebookruntimetemplates$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; options = {}; } @@ -74801,7 +78642,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), @@ -74811,80 +78652,75 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists NotebookRuntimeTemplates in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$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$Notebookruntimetemplates$List; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -74897,91 +78733,86 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+parent}/notebookRuntimeTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a NotebookRuntimeTemplate. + * 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$Notebookruntimetemplates$Patch, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -74995,7 +78826,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -75006,75 +78837,74 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists 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. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -75087,90 +78917,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookruntimetemplates$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + wait( + params?: Params$Resource$Projects$Locations$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - testIamPermissions( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Operations$Wait; options = {}; } @@ -75183,7 +79014,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), @@ -75193,193 +79024,144 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Create - extends StandardParameters { - /** - * Optional. User specified ID for the notebook runtime template. - */ - notebookRuntimeTemplateId?: string; - /** - * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters { /** - * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get + export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters { /** - * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - '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. + * The name of the operation resource. */ - resource?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List + export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The standard list page size. + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. + * The standard list page token. */ pageToken?: string; - /** - * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch + export interface Params$Resource$Projects$Locations$Operations$Wait extends StandardParameters { /** - * The resource name of the NotebookRuntimeTemplate. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed\}"\}` Updatable fields: * `encryption_spec.kms_key_name` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$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$Notebookruntimetemplates$Testiampermissions - extends StandardParameters { - /** - * 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[]; - /** - * 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. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - resource?: string; + timeout?: string; } - export class Resource$Projects$Locations$Notebookruntimetemplates$Operations { + export class Resource$Projects$Locations$Persistentresources { context: APIRequestContext; + operations: Resource$Projects$Locations$Persistentresources$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Persistentresources$Operations( + this.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 PersistentResource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookruntimetemplates$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Persistentresources$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$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$Notebookruntimetemplates$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Persistentresources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Persistentresources$Create; options = {}; } @@ -75392,7 +79174,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/persistentResources').replace( /([^:]\/)\/+/g, '$1' ), @@ -75402,22 +79184,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a PersistentResource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -75425,53 +79207,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params?: Params$Resource$Projects$Locations$Persistentresources$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$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$Notebookruntimetemplates$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Persistentresources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; + {} as Params$Resource$Projects$Locations$Persistentresources$Delete; options = {}; } @@ -75496,17 +79282,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a PersistentResource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -75514,57 +79300,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params?: Params$Resource$Projects$Locations$Persistentresources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$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$Notebookruntimetemplates$Operations$Get; + {}) as Params$Resource$Projects$Locations$Persistentresources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; + {} as Params$Resource$Projects$Locations$Persistentresources$Get; options = {}; } @@ -75589,17 +79375,19 @@ export namespace aiplatform_v1beta1 { 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 PersistentResources in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -75607,57 +79395,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params?: Params$Resource$Projects$Locations$Persistentresources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$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$Notebookruntimetemplates$Operations$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; + {} as Params$Resource$Projects$Locations$Persistentresources$List; options = {}; } @@ -75670,7 +79458,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/persistentResources').replace( /([^:]\/)\/+/g, '$1' ), @@ -75680,60 +79468,60 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a PersistentResource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Persistentresources$Patch, options?: MethodOptions ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, callback: BodyResponseCallback ): void; - wait( + patch( callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait + | Params$Resource$Projects$Locations$Persistentresources$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -75749,13 +79537,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Persistentresources$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; + {} as Params$Resource$Projects$Locations$Persistentresources$Patch; options = {}; } @@ -75768,7 +79556,100 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( + 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); + } + } + + /** + * Reboots a PersistentResource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: StreamMethodOptions + ): GaxiosPromise; + reboot( + params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options?: MethodOptions + ): GaxiosPromise; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + callback: BodyResponseCallback + ): void; + reboot( + callback: BodyResponseCallback + ): void; + reboot( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Persistentresources$Reboot + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Persistentresources$Reboot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; + 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}:reboot').replace( /([^:]\/)\/+/g, '$1' ), @@ -75793,59 +79674,81 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel + export interface Params$Resource$Projects$Locations$Persistentresources$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + /** + * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. + */ + persistentResourceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1PersistentResource; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete + export interface Params$Resource$Projects$Locations$Persistentresources$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get + export interface Params$Resource$Projects$Locations$Persistentresources$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List + export interface Params$Resource$Projects$Locations$Persistentresources$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list page size. */ - filter?: string; + pageSize?: number; /** - * The name of the operation's parent resource. + * Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Patch + extends StandardParameters { + /** + * Immutable. Resource name of a PersistentResource. */ name?: string; /** - * The standard list page size. + * Required. Specify the fields to be overwritten in the PersistentResource by the update method. */ - pageSize?: number; + updateMask?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1PersistentResource; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait + export interface Params$Resource$Projects$Locations$Persistentresources$Reboot extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Persistentresources$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -75860,31 +79763,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel + | Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -75900,12 +79803,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; options = {}; } @@ -75951,31 +79855,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete + | Params$Resource$Projects$Locations$Persistentresources$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -75991,12 +79895,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; options = {}; } @@ -76039,27 +79944,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Operations$Get, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -76067,7 +79972,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get + | Params$Resource$Projects$Locations$Persistentresources$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76083,12 +79988,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; options = {}; } @@ -76131,27 +80037,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Operations$List, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, callback: BodyResponseCallback ): void; list( @@ -76159,7 +80065,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List + | Params$Resource$Projects$Locations$Persistentresources$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76175,12 +80081,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$List; options = {}; } @@ -76228,27 +80135,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Operations$Wait, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -76256,7 +80163,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Wait + | Params$Resource$Projects$Locations$Persistentresources$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76272,12 +80179,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Wait; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; options = {}; } @@ -76315,28 +80223,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$List extends StandardParameters { /** * The standard list filter. @@ -76355,7 +80263,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Operations$Wait + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -76367,55 +80275,54 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Persistentresources { + export class Resource$Projects$Locations$Pipelinejobs { context: APIRequestContext; - operations: Resource$Projects$Locations$Persistentresources$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Persistentresources$Operations( - this.context - ); + operations: Resource$Projects$Locations$Pipelinejobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Pipelinejobs$Operations( + this.context + ); } /** - * Creates a PersistentResource. + * Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Persistentresources$Create, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Persistentresources$Create, + batchCancel( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, callback: BodyResponseCallback ): void; - create( + batchCancel( callback: BodyResponseCallback ): void; - create( + batchCancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Create + | Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76431,13 +80338,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Create; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Create; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; options = {}; } @@ -76450,10 +80357,9 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/persistentResources').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+parent}/pipelineJobs:batchCancel' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -76475,43 +80381,43 @@ export namespace aiplatform_v1beta1 { } /** - * Deletes a PersistentResource. + * Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Persistentresources$Delete, + batchDelete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, callback: BodyResponseCallback ): void; - delete( + batchDelete( callback: BodyResponseCallback ): void; - delete( + batchDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Delete + | Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76527,13 +80433,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Delete; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Delete; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; options = {}; } @@ -76546,15 +80452,17 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta1/{+parent}/pipelineJobs:batchDelete' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -76568,65 +80476,60 @@ export namespace aiplatform_v1beta1 { } /** - * Gets a PersistentResource. + * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Persistentresources$Get, + cancel( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$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$Persistentresources$Get; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Get; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; options = {}; } @@ -76639,8 +80542,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -76651,77 +80557,74 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists PersistentResources in a Location. + * Creates a PipelineJob. A PipelineJob will run immediately when created. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Persistentresources$List, + create( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Persistentresources$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$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$Persistentresources$List; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$List; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Create; options = {}; } @@ -76734,11 +80637,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/persistentResources').replace( + url: (rootUrl + '/v1beta1/{+parent}/pipelineJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -76749,55 +80652,55 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a PersistentResource. + * Deletes a PipelineJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Persistentresources$Patch, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Persistentresources$Patch, + delete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Patch + | Params$Resource$Projects$Locations$Pipelinejobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76813,13 +80716,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Patch; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Patch; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Delete; options = {}; } @@ -76833,7 +80735,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -76854,65 +80756,64 @@ export namespace aiplatform_v1beta1 { } /** - * Reboots a PersistentResource. + * Gets a PipelineJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: StreamMethodOptions ): GaxiosPromise; - reboot( - params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, + get( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Get, options?: MethodOptions - ): GaxiosPromise; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + callback: BodyResponseCallback ): void; - reboot( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - reboot( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Reboot - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$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$Persistentresources$Reboot; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Get; options = {}; } @@ -76925,106 +80826,222 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:reboot').replace( + 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 PipelineJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Pipelinejobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelinejobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelinejobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/pipelineJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Persistentresources$Create + export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel extends StandardParameters { /** - * Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - /** - * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. - */ - persistentResourceId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PersistentResource; + requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest; } - export interface Params$Resource$Projects$Locations$Persistentresources$Delete + export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete extends StandardParameters { /** - * Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest; } - export interface Params$Resource$Projects$Locations$Persistentresources$Get + export interface Params$Resource$Projects$Locations$Pipelinejobs$Cancel extends StandardParameters { /** - * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1CancelPipelineJobRequest; } - export interface Params$Resource$Projects$Locations$Persistentresources$List + export interface Params$Resource$Projects$Locations$Pipelinejobs$Create extends StandardParameters { /** - * Optional. The standard list page size. + * Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` */ - pageSize?: number; + parent?: string; /** - * Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. + * The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. */ - pageToken?: string; + pipelineJobId?: string; + /** - * Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudAiplatformV1beta1PipelineJob; } - export interface Params$Resource$Projects$Locations$Persistentresources$Patch + export interface Params$Resource$Projects$Locations$Pipelinejobs$Delete extends StandardParameters { /** - * Immutable. Resource name of a PersistentResource. + * Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` */ name?: string; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Get + extends StandardParameters { /** - * Required. Specify the fields to be overwritten in the PersistentResource by the update method. - */ - updateMask?: string; - - /** - * Request body metadata + * Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PersistentResource; + name?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$Reboot + export interface Params$Resource$Projects$Locations$Pipelinejobs$List extends StandardParameters { /** - * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". */ - name?: string; - + filter?: string; /** - * Request body metadata + * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest; + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export class Resource$Projects$Locations$Persistentresources$Operations { + export class Resource$Projects$Locations$Pipelinejobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -77039,31 +81056,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77079,13 +81096,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; options = {}; } @@ -77131,31 +81148,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Delete + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77171,13 +81188,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; options = {}; } @@ -77220,27 +81237,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -77248,7 +81265,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Get + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77264,13 +81281,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; options = {}; } @@ -77313,27 +81330,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -77341,7 +81358,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$List + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77357,13 +81374,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$List; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$List; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; options = {}; } @@ -77411,27 +81428,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -77439,7 +81456,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Wait + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77455,13 +81472,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; options = {}; } @@ -77499,28 +81516,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Delete + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Get + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$List + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -77539,7 +81556,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Wait + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -77551,76 +81568,83 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Pipelinejobs { + export class Resource$Projects$Locations$Publishers { context: APIRequestContext; - operations: Resource$Projects$Locations$Pipelinejobs$Operations; + models: Resource$Projects$Locations$Publishers$Models; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Pipelinejobs$Operations( + this.models = new Resource$Projects$Locations$Publishers$Models( this.context ); } + } + + export class Resource$Projects$Locations$Publishers$Models { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. + * Return a list of tokens based on the input text. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: StreamMethodOptions ): GaxiosPromise; - batchCancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + computeTokens( + params?: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options?: MethodOptions - ): GaxiosPromise; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + ): GaxiosPromise; + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + callback: BodyResponseCallback ): void; - batchCancel( - callback: BodyResponseCallback + computeTokens( + callback: BodyResponseCallback ): void; - batchCancel( + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Computetokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + {} as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; options = {}; } @@ -77633,179 +81657,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+parent}/pipelineJobs:batchCancel' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. + * Perform a token counting. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Locations$Pipelinejobs$Batchdelete, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: StreamMethodOptions ): GaxiosPromise; - batchDelete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + countTokens( + params?: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options?: MethodOptions - ): GaxiosPromise; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + ): GaxiosPromise; + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + callback: BodyResponseCallback ): void; - batchDelete( - callback: BodyResponseCallback + countTokens( + callback: BodyResponseCallback ): void; - batchDelete( + countTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Counttokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/pipelineJobs: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); - } - } - - /** - * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `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$Pipelinejobs$Cancel, - options: StreamMethodOptions - ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, - options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; + {} as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; options = {}; } @@ -77818,7 +81755,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+endpoint}:countTokens').replace( /([^:]\/)\/+/g, '$1' ), @@ -77828,79 +81765,82 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a PipelineJob. A PipelineJob will run immediately when created. + * Exports a publisher model to a user provided Google Cloud Storage bucket. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + export( + params: Params$Resource$Projects$Locations$Publishers$Models$Export, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Create, + export( + params?: Params$Resource$Projects$Locations$Publishers$Models$Export, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Publishers$Models$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + export( + params: Params$Resource$Projects$Locations$Publishers$Models$Export, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, - callback: BodyResponseCallback + export( + params: Params$Resource$Projects$Locations$Publishers$Models$Export, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + export( + callback: BodyResponseCallback ): void; - create( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Export + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Create; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Create; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Export; options = {}; } @@ -77913,7 +81853,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/pipelineJobs').replace( + url: (rootUrl + '/v1beta1/{+parent}/{+name}:export').replace( /([^:]\/)\/+/g, '$1' ), @@ -77923,60 +81863,58 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['parent', 'name'], + pathParams: ['name', 'parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a PipelineJob. + * Fetch an asynchronous online prediction operation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Pipelinejobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + fetchPredictOperation( + params?: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, callback: BodyResponseCallback ): void; - delete( + fetchPredictOperation( callback: BodyResponseCallback ): void; - delete( + fetchPredictOperation( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Delete + | Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77992,12 +81930,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Delete; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Delete; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; options = {}; } @@ -78010,15 +81949,17 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta1/{+endpoint}:fetchPredictOperation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { @@ -78032,64 +81973,65 @@ export namespace aiplatform_v1beta1 { } /** - * Gets a PipelineJob. + * Fetches the configs of 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. */ - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + fetchPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Get, + fetchPublisherModelConfig( + params?: Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + ): GaxiosPromise; + fetchPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + fetchPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, - callback: BodyResponseCallback + fetchPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + fetchPublisherModelConfig( + callback: BodyResponseCallback ): void; - get( + fetchPublisherModelConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Get; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Get; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig; options = {}; } @@ -78102,7 +82044,9 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1beta1/{+name}:fetchPublisherModelConfig' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -78114,76 +82058,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists PipelineJobs in a Location. + * Generate content with multimodal inputs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Pipelinejobs$List, + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Pipelinejobs$List, + generateContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, + ): GaxiosPromise; + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + generateContent( + callback: BodyResponseCallback ): void; - list( + generateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Generatecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$List; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$List; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; options = {}; } @@ -78196,189 +82141,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/pipelineJobs').replace( + url: (rootUrl + '/v1beta1/{+model}:generateContent').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel - extends StandardParameters { - /** - * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete - extends StandardParameters { - /** - * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Cancel - extends StandardParameters { - /** - * Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1CancelPipelineJobRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. - */ - pipelineJobId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PipelineJob; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Delete - extends StandardParameters { - /** - * Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Get - extends StandardParameters { - /** - * Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$List - extends StandardParameters { - /** - * Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". - */ - filter?: string; - /** - * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Pipelinejobs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Gets the 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. */ - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + getIamPolicy( + params: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy; options = {}; } @@ -78391,7 +82237,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -78401,76 +82247,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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`. + * 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. */ - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + predict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Predict, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + ): GaxiosPromise; + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + predict( + callback: BodyResponseCallback + ): void; + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Predict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Publishers$Models$Predict; options = {}; } @@ -78483,65 +82333,69 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Pipelinejobs$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + predictLongRunning( + params?: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, callback: BodyResponseCallback ): void; - get( + predictLongRunning( callback: BodyResponseCallback ): void; - get( + predictLongRunning( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get + | Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -78557,13 +82411,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; options = {}; } @@ -78576,15 +82430,18 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+endpoint}:predictLongRunning').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { @@ -78598,65 +82455,61 @@ export namespace aiplatform_v1beta1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this 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. */ - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + rawPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + ): GaxiosPromise; + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + callback: BodyResponseCallback ): void; - list( + rawPredict(callback: BodyResponseCallback): void; + rawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Rawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; + {} as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; options = {}; } @@ -78669,92 +82522,90 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+endpoint}:rawPredict').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Perform a server-side streaming online prediction request for Vertex LLM streaming. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + serverStreamingPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + ): GaxiosPromise; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, - callback: BodyResponseCallback + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + serverStreamingPredict( + callback: BodyResponseCallback ): void; - wait( + serverStreamingPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; options = {}; } @@ -78767,160 +82618,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+endpoint}:serverStreamingPredict' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$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 interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Publishers { - context: APIRequestContext; - models: Resource$Projects$Locations$Publishers$Models; - constructor(context: APIRequestContext) { - this.context = context; - this.models = new Resource$Projects$Locations$Publishers$Models( - this.context - ); - } - } - - export class Resource$Projects$Locations$Publishers$Models { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Return a list of tokens based on the input text. + * Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + setPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig, options: StreamMethodOptions ): GaxiosPromise; - computeTokens( - params?: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + setPublisherModelConfig( + params?: Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig, options?: MethodOptions - ): GaxiosPromise; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + ): GaxiosPromise; + setPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + setPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - callback: BodyResponseCallback + setPublisherModelConfig( + params: Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + setPublisherModelConfig( + callback: BodyResponseCallback ): void; - computeTokens( + setPublisherModelConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Computetokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; + {} as Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig; options = {}; } @@ -78933,7 +82715,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+endpoint}:computeTokens').replace( + url: (rootUrl + '/v1beta1/{+name}:setPublisherModelConfig').replace( /([^:]\/)\/+/g, '$1' ), @@ -78943,82 +82725,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a token counting. + * Generate content with multimodal inputs with streaming support. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions ): GaxiosPromise; - countTokens( - params?: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + streamGenerateContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options?: MethodOptions - ): GaxiosPromise; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + ): GaxiosPromise; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, - callback: BodyResponseCallback + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + streamGenerateContent( + callback: BodyResponseCallback ): void; - countTokens( + streamGenerateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Counttokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; + {} as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; options = {}; } @@ -79031,7 +82811,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+endpoint}:countTokens').replace( + url: (rootUrl + '/v1beta1/{+model}:streamGenerateContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -79041,82 +82821,80 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Fetch an asynchronous online prediction operation. + * Perform a streaming online prediction with an arbitrary HTTP payload. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options: StreamMethodOptions ): GaxiosPromise; - fetchPredictOperation( - params?: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + streamRawPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options?: MethodOptions - ): GaxiosPromise; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + ): GaxiosPromise; + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + callback: BodyResponseCallback ): void; - fetchPredictOperation( - callback: BodyResponseCallback + streamRawPredict( + callback: BodyResponseCallback ): void; - fetchPredictOperation( + streamRawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; + {} as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; options = {}; } @@ -79129,9 +82907,10 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+endpoint}:fetchPredictOperation' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+endpoint}:streamRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -79143,75 +82922,256 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Computetokens + extends StandardParameters { /** - * Generate content with multimodal inputs. + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ComputeTokensRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Counttokens + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1CountTokensRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Export + extends StandardParameters { + /** + * 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` + */ + name?: string; + /** + * Required. The Location to export the model weights from Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ExportPublisherModelRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FetchPredictOperationRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Fetchpublishermodelconfig + extends StandardParameters { + /** + * Required. The name of the publisher model, in the format of `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Generatecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$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$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$Projects$Locations$Publishers$Models$Predictlongrunning + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1PredictLongRunningRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Rawpredict + 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$GoogleCloudAiplatformV1beta1RawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict + 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$GoogleCloudAiplatformV1beta1StreamingPredictRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Setpublishermodelconfig + extends StandardParameters { + /** + * Required. The name of the publisher model, in the format of `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + 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$GoogleCloudAiplatformV1beta1StreamRawPredictRequest; + } + + export class Resource$Projects$Locations$Ragcorpora { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragcorpora$Operations; + ragFiles: Resource$Projects$Locations$Ragcorpora$Ragfiles; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Ragcorpora$Operations( + this.context + ); + this.ragFiles = new Resource$Projects$Locations$Ragcorpora$Ragfiles( + this.context + ); + } + + /** + * Creates a RagCorpus. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: StreamMethodOptions ): GaxiosPromise; - generateContent( - params?: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + create( + params?: Params$Resource$Projects$Locations$Ragcorpora$Create, options?: MethodOptions - ): GaxiosPromise; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - generateContent( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Generatecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Publishers$Models$Generatecontent; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Create; options = {}; } @@ -79224,7 +83184,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+model}:generateContent').replace( + url: (rootUrl + '/v1beta1/{+parent}/ragCorpora').replace( /([^:]\/)\/+/g, '$1' ), @@ -79234,80 +83194,79 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Deletes a RagCorpus. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Publishers$Models$Getiampolicy, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Delete, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - getIamPolicy( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Publishers$Models$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Delete; options = {}; } @@ -79320,90 +83279,86 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Perform an online prediction. + * Gets a RagCorpus. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Projects$Locations$Publishers$Models$Predict, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: StreamMethodOptions ): GaxiosPromise; - predict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Predict, + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Get, options?: MethodOptions - ): GaxiosPromise; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Get, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - predict( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Predict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Publishers$Models$Predict; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Predict; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Get; options = {}; } @@ -79416,91 +83371,88 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** + * Lists RagCorpora in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: StreamMethodOptions ): GaxiosPromise; - predictLongRunning( - params?: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$List, options?: MethodOptions - ): GaxiosPromise; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$List, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - predictLongRunning( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Publishers$Models$Predictlongrunning; + {}) as Params$Resource$Projects$Locations$Ragcorpora$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$List; options = {}; } @@ -79513,86 +83465,91 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+endpoint}:predictLongRunning').replace( + url: (rootUrl + '/v1beta1/{+parent}/ragCorpora').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. + * Updates a RagCorpus. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: StreamMethodOptions ): GaxiosPromise; - rawPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + patch( + params?: Params$Resource$Projects$Locations$Ragcorpora$Patch, options?: MethodOptions - ): GaxiosPromise; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + callback: BodyResponseCallback ): void; - rawPredict(callback: BodyResponseCallback): void; - rawPredict( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Rawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Publishers$Models$Rawpredict; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Patch; options = {}; } @@ -79605,90 +83562,148 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+endpoint}:rawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + 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$Ragcorpora$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; /** - * Perform a server-side streaming online prediction request for Vertex LLM streaming. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RagCorpus; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Delete + extends StandardParameters { + /** + * Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. + */ + force?: boolean; + /** + * Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Get + extends StandardParameters { + /** + * Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$List + extends StandardParameters { + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Patch + extends StandardParameters { + /** + * Output only. The resource name of the RagCorpus. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RagCorpus; + } + + export class Resource$Projects$Locations$Ragcorpora$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. */ - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - serverStreamingPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + cancel( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + callback: BodyResponseCallback ): void; - serverStreamingPredict( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Publishers$Models$Serverstreamingpredict; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; options = {}; } @@ -79701,91 +83716,86 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta1/{+endpoint}:serverStreamingPredict' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Generate content with multimodal inputs with streaming support. + * 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. */ - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - streamGenerateContent( - params?: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + callback: BodyResponseCallback ): void; - streamGenerateContent( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Operations$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$Publishers$Models$Streamgeneratecontent; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; options = {}; } @@ -79798,90 +83808,87 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+model}:streamGenerateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a streaming online prediction with an arbitrary HTTP payload. + * 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. */ - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - streamRawPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + callback: BodyResponseCallback ): void; - streamRawPredict( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - streamRawPredict( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Publishers$Models$Streamrawpredict; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; options = {}; } @@ -79894,215 +83901,163 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+endpoint}:streamRawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Publishers$Models$Computetokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ComputeTokensRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Counttokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1CountTokensRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1FetchPredictOperationRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Generatecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$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$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$Projects$Locations$Publishers$Models$Predictlongrunning - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PredictLongRunningRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Rawpredict - 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$GoogleCloudAiplatformV1beta1RawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamingPredictRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * 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. */ - model?: string; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamRawPredictRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Ragcorpora { - context: APIRequestContext; - operations: Resource$Projects$Locations$Ragcorpora$Operations; - ragFiles: Resource$Projects$Locations$Ragcorpora$Ragfiles; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Ragcorpora$Operations( - this.context - ); - this.ragFiles = new Resource$Projects$Locations$Ragcorpora$Ragfiles( - this.context - ); + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } } /** - * Creates a RagCorpus. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$Create, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Ragcorpora$Create, + wait( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, callback: BodyResponseCallback ): void; - create( + wait( callback: BodyResponseCallback ): void; - create( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Create + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80118,12 +84073,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Create; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Create; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; options = {}; } @@ -80136,7 +84092,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/ragCorpora').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), @@ -80146,8 +84102,8 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -80159,9 +84115,73 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel + extends StandardParameters { /** - * Deletes a RagCorpus. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$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 interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Ragcorpora$Ragfiles { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations( + this.context + ); + } + + /** + * Deletes a RagFile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -80169,27 +84189,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, callback: BodyResponseCallback ): void; delete( @@ -80197,7 +84217,7 @@ export namespace aiplatform_v1beta1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Delete + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80213,12 +84233,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Delete; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; options = {}; } @@ -80253,7 +84274,7 @@ export namespace aiplatform_v1beta1 { } /** - * Gets a RagCorpus. + * Gets a RagFile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -80261,56 +84282,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Get, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$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$Ragcorpora$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Get; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; options = {}; } @@ -80335,76 +84357,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists RagCorpora in a Location. + * Import files from Google Cloud Storage or Google Drive into a RagCorpus. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$List, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$List, + import( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - list( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$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$Ragcorpora$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$List; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; options = {}; } @@ -80417,11 +84440,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/ragCorpora').replace( + url: (rootUrl + '/v1beta1/{+parent}/ragFiles:import').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -80432,76 +84455,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a RagCorpus. + * Lists RagFiles in a RagCorpus. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$Patch, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Ragcorpora$Patch, + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$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$Ragcorpora$Patch; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Patch; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; options = {}; } @@ -80514,87 +84536,76 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+parent}/ragFiles').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$Ragcorpora$Create + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete extends StandardParameters { /** - * Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1RagCorpus; + name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Delete + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get extends StandardParameters { /** - * Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. - */ - force?: boolean; - /** - * Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Get + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import extends StandardParameters { /** - * Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ImportRagFilesRequest; } - export interface Params$Resource$Projects$Locations$Ragcorpora$List + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List extends StandardParameters { /** * Optional. The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. + * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Patch - extends StandardParameters { - /** - * Output only. The resource name of the RagCorpus. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1RagCorpus; - } - export class Resource$Projects$Locations$Ragcorpora$Operations { + export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -80609,31 +84620,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80649,13 +84660,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; options = {}; } @@ -80701,31 +84712,31 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80741,13 +84752,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; options = {}; } @@ -80790,27 +84801,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -80818,7 +84829,7 @@ export namespace aiplatform_v1beta1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Get + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80834,13 +84845,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; options = {}; } @@ -80883,27 +84894,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, callback: BodyResponseCallback ): void; list( @@ -80911,7 +84922,7 @@ export namespace aiplatform_v1beta1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$List + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80927,13 +84938,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; options = {}; } @@ -80981,27 +84992,27 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -81009,7 +85020,7 @@ export namespace aiplatform_v1beta1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81025,13 +85036,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; options = {}; } @@ -81069,28 +85080,28 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Get + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$List + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { /** * The standard list filter. @@ -81109,7 +85120,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -81121,19 +85132,118 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Ragcorpora$Ragfiles { + export class Resource$Projects$Locations$Ragengineconfig { context: APIRequestContext; - operations: Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations; + operations: Resource$Projects$Locations$Ragengineconfig$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations( + new Resource$Projects$Locations$Ragengineconfig$Operations( this.context ); } + } + + export class Resource$Projects$Locations$Ragengineconfig$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Deletes a RagFile. + * 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$Ragengineconfig$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; + 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}: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`. @@ -81141,57 +85251,53 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$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$Ragcorpora$Ragfiles$Delete; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; options = {}; } @@ -81216,17 +85322,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a RagFile. + * 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`. @@ -81234,57 +85340,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragengineconfig$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$Ragcorpora$Ragfiles$Get; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; options = {}; } @@ -81309,77 +85415,75 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Import files from Google Cloud Storage or Google Drive into a RagCorpus. + * 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. */ - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + list( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + list( + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + list( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragengineconfig$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$Ragcorpora$Ragfiles$Import; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; options = {}; } @@ -81392,90 +85496,92 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/ragFiles:import').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists RagFiles in a RagCorpus. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Ragcorpora$Ragfiles$List, + wait( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + wait( + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + wait( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; options = {}; } @@ -81488,137 +85594,158 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/ragFiles').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel extends StandardParameters { /** - * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete extends StandardParameters { /** - * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get extends StandardParameters { /** - * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ImportRagFilesRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$List extends StandardParameters { /** - * Optional. The standard list page size. + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + * The standard list page token. */ pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait + extends StandardParameters { /** - * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * The name of the operation resource to wait on. */ - parent?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { + export class Resource$Projects$Locations$Reasoningengines { context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Operations; + sessions: Resource$Projects$Locations$Reasoningengines$Sessions; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Operations( + this.context + ); + this.sessions = new Resource$Projects$Locations$Reasoningengines$Sessions( + this.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 reasoning 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. */ - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Ragcorpora$Ragfiles$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Create; options = {}; } @@ -81631,7 +85758,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/reasoningEngines').replace( /([^:]\/)\/+/g, '$1' ), @@ -81641,22 +85768,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a reasoning engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -81664,53 +85791,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Ragcorpora$Ragfiles$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Delete; options = {}; } @@ -81735,17 +85866,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a reasoning engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -81753,57 +85884,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Ragcorpora$Ragfiles$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Reasoningengines$Get; options = {}; } @@ -81828,17 +85958,19 @@ export namespace aiplatform_v1beta1 { 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 reasoning engines in a location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -81846,57 +85978,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Ragcorpora$Ragfiles$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + params = {} as Params$Resource$Projects$Locations$Reasoningengines$List; options = {}; } @@ -81909,7 +86040,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/reasoningEngines').replace( /([^:]\/)\/+/g, '$1' ), @@ -81919,60 +86050,60 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a reasoning 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. */ - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Reasoningengines$Patch, options?: MethodOptions ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, callback: BodyResponseCallback ): void; - wait( + patch( callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + | Params$Resource$Projects$Locations$Reasoningengines$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81988,13 +86119,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Patch; options = {}; } @@ -82007,11 +86138,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -82030,131 +86158,67 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$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 interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Reasoningengines { - context: APIRequestContext; - operations: Resource$Projects$Locations$Reasoningengines$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Reasoningengines$Operations( - this.context - ); - } /** - * Creates a reasoning engine. + * Queries using a reasoning 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$Reasoningengines$Create, + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Create, + query( + params?: Params$Resource$Projects$Locations$Reasoningengines$Query, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + ): GaxiosPromise; + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + query( + callback: BodyResponseCallback ): void; - create( + query( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Create; + {} as Params$Resource$Projects$Locations$Reasoningengines$Query; options = {}; } @@ -82167,7 +86231,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/reasoningEngines').replace( + url: (rootUrl + '/v1beta1/{+name}:query').replace( /([^:]\/)\/+/g, '$1' ), @@ -82177,80 +86241,78 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a reasoning engine. + * Streams queries using a reasoning 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$Reasoningengines$Delete, + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Delete, + streamQuery( + params?: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + ): GaxiosPromise; + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + callback: BodyResponseCallback ): void; - delete( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; options = {}; } @@ -82263,8 +86325,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+name}:streamQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -82275,74 +86340,168 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Create + extends StandardParameters { /** - * Gets a reasoning engine. + * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngine; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Delete + extends StandardParameters { + /** + * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + */ + force?: boolean; + /** + * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Get + extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$List + extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the ReasoningEngine. + */ + name?: string; + /** + * Optional. Mask specifying which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngine; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Query + extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Streamquery + extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest; + } + + export class Resource$Projects$Locations$Reasoningengines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Get, + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Reasoningengines$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Reasoningengines$Get; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; options = {}; } @@ -82355,8 +86514,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -82367,76 +86529,71 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists reasoning engines in a location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$List, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Operations$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$Reasoningengines$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Reasoningengines$List; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; options = {}; } @@ -82449,70 +86606,65 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/reasoningEngines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a reasoning engine. + * 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$Reasoningengines$Patch, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Reasoningengines$Patch, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Patch + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82528,13 +86680,13 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Patch; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Patch; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; options = {}; } @@ -82548,7 +86700,7 @@ export namespace aiplatform_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -82569,65 +86721,65 @@ export namespace aiplatform_v1beta1 { } /** - * Queries using a reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - query( - params?: Params$Resource$Projects$Locations$Reasoningengines$Query, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - query( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Query - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Reasoningengines$Query; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Query; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; options = {}; } @@ -82640,11 +86792,11 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:query').replace( + url: (rootUrl + '/v1beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -82655,73 +86807,77 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Streams queries using a reasoning engine. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - streamQuery( - params?: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Streamquery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; options = {}; } @@ -82734,7 +86890,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:streamQuery').replace( + url: (rootUrl + '/v1beta1/{+name}:wait').replace( /([^:]\/)\/+/g, '$1' ), @@ -82749,164 +86905,139 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Create + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngine; + name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Delete + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Get + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Get extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$List + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$List extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Patch - extends StandardParameters { - /** - * Identifier. The resource name of the ReasoningEngine. + * The name of the operation's parent resource. */ name?: string; /** - * Optional. Mask specifying which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngine; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Query - extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The standard list page size. */ - name?: string; - + pageSize?: number; /** - * Request body metadata + * The standard list page token. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest; + pageToken?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Streamquery + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource to wait on. */ name?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest; + timeout?: string; } - export class Resource$Projects$Locations$Reasoningengines$Operations { + export class Resource$Projects$Locations$Reasoningengines$Sessions { context: APIRequestContext; + events: Resource$Projects$Locations$Reasoningengines$Sessions$Events; constructor(context: APIRequestContext) { this.context = context; + this.events = + new Resource$Projects$Locations$Reasoningengines$Sessions$Events( + this.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`. + * Appends an event to a given 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. */ - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + appendEvent( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + ): GaxiosPromise; + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, - callback: BodyResponseCallback + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + appendEvent( + callback: BodyResponseCallback + ): void; + appendEvent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; options = {}; } @@ -82919,7 +87050,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+name}:appendEvent').replace( /([^:]\/)\/+/g, '$1' ), @@ -82934,17 +87065,115 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a new 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. + */ + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/sessions').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 details of the specific Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -82952,53 +87181,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Reasoningengines$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; options = {}; } @@ -83023,17 +87256,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets details of the specific Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -83041,57 +87274,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Reasoningengines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; options = {}; } @@ -83116,17 +87349,19 @@ export namespace aiplatform_v1beta1 { 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 Sessions in a given reasoning engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -83134,57 +87369,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Reasoningengines$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; options = {}; } @@ -83197,7 +87432,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -83207,82 +87442,82 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates the specific 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. */ - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Reasoningengines$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; options = {}; } @@ -83295,11 +87530,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -83310,66 +87542,215 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SessionEvent; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Session; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Get + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$List + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`. */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned. */ pageSize?: number; /** - * The standard list page token. + * Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. */ pageToken?: string; + /** + * Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Session; + } + + export class Resource$Projects$Locations$Reasoningengines$Sessions$Events { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists Events in a given session. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/events').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$Reasoningengines$Sessions$Events$List + extends StandardParameters { + /** + * Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. + */ + pageToken?: string; + /** + * Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + */ + parent?: string; } export class Resource$Projects$Locations$Schedules { @@ -95925,6 +100306,231 @@ export namespace aiplatform_v1beta1 { name?: string; } + export class Resource$Projects$Modelgardeneula { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Accepts the EULA acceptance status of a publisher model. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accept( + params: Params$Resource$Projects$Modelgardeneula$Accept, + options: StreamMethodOptions + ): GaxiosPromise; + accept( + params?: Params$Resource$Projects$Modelgardeneula$Accept, + options?: MethodOptions + ): GaxiosPromise; + accept( + params: Params$Resource$Projects$Modelgardeneula$Accept, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accept( + params: Params$Resource$Projects$Modelgardeneula$Accept, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accept( + params: Params$Resource$Projects$Modelgardeneula$Accept, + callback: BodyResponseCallback + ): void; + accept( + callback: BodyResponseCallback + ): void; + accept( + paramsOrCallback?: + | Params$Resource$Projects$Modelgardeneula$Accept + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Modelgardeneula$Accept; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Modelgardeneula$Accept; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/modelGardenEula:accept' + ).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 + ); + } + } + + /** + * Checks the EULA acceptance status of a publisher model. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + check( + params: Params$Resource$Projects$Modelgardeneula$Check, + options: StreamMethodOptions + ): GaxiosPromise; + check( + params?: Params$Resource$Projects$Modelgardeneula$Check, + options?: MethodOptions + ): GaxiosPromise; + check( + params: Params$Resource$Projects$Modelgardeneula$Check, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + check( + params: Params$Resource$Projects$Modelgardeneula$Check, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + check( + params: Params$Resource$Projects$Modelgardeneula$Check, + callback: BodyResponseCallback + ): void; + check( + callback: BodyResponseCallback + ): void; + check( + paramsOrCallback?: + | Params$Resource$Projects$Modelgardeneula$Check + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Modelgardeneula$Check; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Modelgardeneula$Check; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/modelGardenEula:check').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$Modelgardeneula$Accept + extends StandardParameters { + /** + * Required. The project requesting access for named model. The format is `projects/{project\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest; + } + export interface Params$Resource$Projects$Modelgardeneula$Check + extends StandardParameters { + /** + * Required. The project requesting access for named model. The format is `projects/{project\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest; + } + export class Resource$Publishers { context: APIRequestContext; models: Resource$Publishers$Models; diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index 7c47c2b4c2c..13c046330e1 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -325,7 +325,7 @@ export namespace alertcenter_v1beta1 { */ startTime?: string | null; /** - * Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](https://developers.google.com/admin-sdk/alertcenter/reference/alert-types). + * Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](https://developers.google.com/workspace/admin/alertcenter/reference/alert-types). */ type?: string | null; /** @@ -422,7 +422,7 @@ export namespace alertcenter_v1beta1 { requestInfo?: Schema$RequestInfo[]; } /** - * * Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the below rules. Calendar settings changed Drive settings changed Email settings changed Mobile settings changed + * Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the following rules: - Calendar settings changed - Drive settings changed - Email settings changed - Mobile settings changed */ export interface Schema$AppSettingsChanged { /** @@ -931,7 +931,7 @@ export namespace alertcenter_v1beta1 { newIncidentTrackingId?: string | null; } /** - * Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications). + * Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/workspace/admin/alertcenter/guides/notifications). */ export interface Schema$Notification { /** @@ -940,7 +940,7 @@ export namespace alertcenter_v1beta1 { cloudPubsubTopic?: Schema$CloudPubsubTopic; } /** - * Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead. + * Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use [MailPhishing](https://developers.google.com/workspace/admin/alertcenter/reference/rest/v1beta1/MailPhishing) instead. */ export interface Schema$PhishingSpike { /** @@ -970,7 +970,7 @@ export namespace alertcenter_v1beta1 { detectorName?: string | null; } /** - * * Event occurred when primary admin changed in customer's account. The event are being received from insight forwarder + * Event occurred when primary admin changed in customer's account. The event are being received from insight forwarder */ export interface Schema$PrimaryAdminChangedEvent { /** @@ -1150,7 +1150,7 @@ export namespace alertcenter_v1beta1 { notifications?: Schema$Notification[]; } /** - * * Event occurred when SSO Profile created in customer's account. The event are being received from insight forwarder + * Event occurred when SSO Profile created in customer's account. The event are being received from insight forwarder */ export interface Schema$SSOProfileCreatedEvent { /** @@ -1159,7 +1159,7 @@ export namespace alertcenter_v1beta1 { inboundSsoProfileName?: string | null; } /** - * * Event occurred when SSO Profile deleted in customer's account. The event are being received from insight forwarder + * Event occurred when SSO Profile deleted in customer's account. The event are being received from insight forwarder */ export interface Schema$SSOProfileDeletedEvent { /** @@ -1168,7 +1168,7 @@ export namespace alertcenter_v1beta1 { inboundSsoProfileName?: string | null; } /** - * * Event occurred when SSO Profile updated in customer's account. The event are being received from insight forwarder + * Event occurred when SSO Profile updated in customer's account. The event are being received from insight forwarder */ export interface Schema$SSOProfileUpdatedEvent { /** @@ -1207,7 +1207,7 @@ export namespace alertcenter_v1beta1 { message?: string | null; } /** - * * Event occurred when password was reset for super admin in customer's account. The event are being received from insight forwarder + * Event occurred when password was reset for super admin in customer's account. The event are being received from insight forwarder */ export interface Schema$SuperAdminPasswordResetEvent { /** @@ -1339,7 +1339,7 @@ export namespace alertcenter_v1beta1 { emailAddress?: string | null; } /** - * * Alerts from UserChanges bucket Rules for predefined rules which contain the below rules. Suspended user made active New user Added User suspended (by admin) User granted admin privileges User admin privileges revoked User deleted Users password changed + * Alerts from UserChanges bucket Rules for predefined rules which contain the following rules: - Suspended user made active - New user added - User suspended (by admin) - User granted admin privileges - User admin privileges revoked - User deleted - Users password changed */ export interface Schema$UserChanges { /** @@ -1360,6 +1360,31 @@ export namespace alertcenter_v1beta1 { */ resourceName?: string | null; } + /** + * Alert that is triggered when a Vault accelerated deletion request is created or canceled. + */ + export interface Schema$VaultAcceleratedDeletion { + /** + * The action can be one of create and cancel + */ + actionType?: string | null; + /** + * Currentlty only Gmail is supported as app type + */ + appType?: string | null; + /** + * The UTC timestamp of when the AD request was created + */ + createTime?: string | null; + /** + * Accelerated deletion request ID intended to be used to construct the Vault UI link to the AD request + */ + deletionRequestId?: string | null; + /** + * Matter ID of the accelerated deletion request intended to be used to construct the Vault UI link to the AD request + */ + matterId?: string | null; + } /** * Issue(s) with sending to voicemail. */ @@ -2098,7 +2123,7 @@ export namespace alertcenter_v1beta1 { */ customerId?: string; /** - * Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.list). + * Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/workspace/admin/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/workspace/admin/alertcenter/reference/filter-fields#alerts.list). */ filter?: string; /** @@ -2343,7 +2368,7 @@ export namespace alertcenter_v1beta1 { */ customerId?: string; /** - * Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list). + * Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/workspace/admin/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/workspace/admin/alertcenter/reference/filter-fields#alerts.feedback.list). */ filter?: string; } diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 9067a4ba70f..5bad73fc6c4 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -186,6 +186,10 @@ export namespace alloydb_v1 { * Output only. The system-generated UID of the cluster which was used to create this resource. */ clusterUid?: string | null; + /** + * Output only. Timestamp when the resource finished being created. + */ + createCompletionTime?: string | null; /** * Output only. Create time stamp */ @@ -263,7 +267,7 @@ export namespace alloydb_v1 { */ uid?: string | null; /** - * Output only. Update time stamp + * Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation. */ updateTime?: string | null; } @@ -1329,7 +1333,7 @@ export namespace alloydb_v1 { */ consumerNetwork?: string | null; /** - * Output only. The status of the service connection policy. + * Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. */ consumerNetworkStatus?: string | null; /** @@ -1341,7 +1345,7 @@ export namespace alloydb_v1 { */ ipAddress?: string | null; /** - * Output only. The status of the PSC service automation connection. + * Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. */ status?: string | null; } @@ -1468,7 +1472,7 @@ export namespace alloydb_v1 { validateOnly?: boolean | null; } /** - * Message for restoring a Cluster from a backup or another cluster at a given point in time. + * Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11 */ export interface Schema$RestoreClusterRequest { /** @@ -2554,6 +2558,10 @@ export namespace alloydb_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 514a98a6e12..7081a36378f 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -186,6 +186,10 @@ export namespace alloydb_v1alpha { * Output only. The system-generated UID of the cluster which was used to create this resource. */ clusterUid?: string | null; + /** + * Output only. Timestamp when the resource finished being created. + */ + createCompletionTime?: string | null; /** * Output only. Create time stamp */ @@ -267,7 +271,7 @@ export namespace alloydb_v1alpha { */ uid?: string | null; /** - * Output only. Update time stamp + * Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation. */ updateTime?: string | null; } @@ -392,7 +396,7 @@ export namespace alloydb_v1alpha { */ etag?: string | null; /** - * Optional. Configuration parameters related to the Gemini in Databases add-on. + * Optional. Deprecated and unused. This field will be removed in the near future. */ geminiConfig?: Schema$GeminiClusterConfig; /** @@ -535,6 +539,59 @@ export namespace alloydb_v1alpha { */ publicIpAddress?: string | null; } + /** + * Configuration for Managed Connection Pool (MCP). + */ + export interface Schema$ConnectionPoolConfig { + /** + * Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. + */ + defaultPoolSize?: string | null; + /** + * Optional. Deprecated; Prefer 'enabled' as this will be removed soon. + */ + enable?: boolean | null; + /** + * Optional. Whether to enable Managed Connection Pool (MCP). + */ + enabled?: boolean | null; + /** + * Optional. Connection Pool flags, as a list of "key": "value" pairs. + */ + flags?: {[key: string]: string} | null; + /** + * Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] + */ + ignoreStartupParameters?: string[] | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. + */ + maxClientConn?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. + */ + maxPreparedStatements?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. + */ + minPoolSize?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. + */ + poolMode?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. + */ + queryWaitTimeout?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. + */ + serverIdleTimeout?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. + */ + statsUsers?: string[] | null; + } /** * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. */ @@ -728,20 +785,20 @@ export namespace alloydb_v1alpha { uri?: string | null; } /** - * Cluster level configuration parameters related to the Gemini in Databases add-on. + * Deprecated and unused. This field will be removed in the near future. */ export interface Schema$GeminiClusterConfig { /** - * Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. + * Output only. Deprecated and unused. This field will be removed in the near future. */ entitled?: boolean | null; } /** - * Instance level configuration parameters related to the Gemini in Databases add-on. + * Deprecated and unused. This field will be removed in the near future. */ export interface Schema$GeminiInstanceConfig { /** - * Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. + * Output only. Deprecated and unused. This field will be removed in the near future. */ entitled?: boolean | null; } @@ -879,6 +936,10 @@ export namespace alloydb_v1alpha { * Optional. Client connection specific configurations */ clientConnectionConfig?: Schema$ClientConnectionConfig; + /** + * Optional. The configuration for Managed Connection Pool (MCP). + */ + connectionPoolConfig?: Schema$ConnectionPoolConfig; /** * Output only. Create time stamp */ @@ -908,7 +969,7 @@ export namespace alloydb_v1alpha { */ gceZone?: string | null; /** - * Optional. Configuration parameters related to the Gemini in Databases add-on. + * Optional. Deprecated and unused. This field will be removed in the near future. */ geminiConfig?: Schema$GeminiInstanceConfig; /** @@ -1378,7 +1439,7 @@ export namespace alloydb_v1alpha { */ consumerNetwork?: string | null; /** - * Output only. The status of the service connection policy. + * Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. */ consumerNetworkStatus?: string | null; /** @@ -1390,7 +1451,7 @@ export namespace alloydb_v1alpha { */ ipAddress?: string | null; /** - * Output only. The status of the PSC service automation connection. + * Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. */ status?: string | null; } @@ -1517,7 +1578,7 @@ export namespace alloydb_v1alpha { validateOnly?: boolean | null; } /** - * Message for restoring a Cluster from a backup or another cluster at a given point in time. + * Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11 */ export interface Schema$RestoreClusterRequest { /** @@ -2612,6 +2673,10 @@ export namespace alloydb_v1alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 572f619bb85..64a07093e3d 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -186,6 +186,10 @@ export namespace alloydb_v1beta { * Output only. The system-generated UID of the cluster which was used to create this resource. */ clusterUid?: string | null; + /** + * Output only. Timestamp when the resource finished being created. + */ + createCompletionTime?: string | null; /** * Output only. Create time stamp */ @@ -263,7 +267,7 @@ export namespace alloydb_v1beta { */ uid?: string | null; /** - * Output only. Update time stamp + * Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation. */ updateTime?: string | null; } @@ -384,7 +388,7 @@ export namespace alloydb_v1beta { */ etag?: string | null; /** - * Optional. Configuration parameters related to the Gemini in Databases add-on. + * Optional. Deprecated and unused. This field will be removed in the near future. */ geminiConfig?: Schema$GeminiClusterConfig; /** @@ -523,6 +527,59 @@ export namespace alloydb_v1beta { */ publicIpAddress?: string | null; } + /** + * Configuration for Managed Connection Pool (MCP). + */ + export interface Schema$ConnectionPoolConfig { + /** + * Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. + */ + defaultPoolSize?: string | null; + /** + * Optional. Deprecated; Prefer 'enabled' as this will be removed soon. + */ + enable?: boolean | null; + /** + * Optional. Whether to enable Managed Connection Pool (MCP). + */ + enabled?: boolean | null; + /** + * Optional. Connection Pool flags, as a list of "key": "value" pairs. + */ + flags?: {[key: string]: string} | null; + /** + * Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] + */ + ignoreStartupParameters?: string[] | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. + */ + maxClientConn?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. + */ + maxPreparedStatements?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. + */ + minPoolSize?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. + */ + poolMode?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. + */ + queryWaitTimeout?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. + */ + serverIdleTimeout?: string | null; + /** + * Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. + */ + statsUsers?: string[] | null; + } /** * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. */ @@ -716,20 +773,20 @@ export namespace alloydb_v1beta { uri?: string | null; } /** - * Cluster level configuration parameters related to the Gemini in Databases add-on. + * Deprecated and unused. This field will be removed in the near future. */ export interface Schema$GeminiClusterConfig { /** - * Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. + * Output only. Deprecated and unused. This field will be removed in the near future. */ entitled?: boolean | null; } /** - * Instance level configuration parameters related to the Gemini in Databases add-on. + * Deprecated and unused. This field will be removed in the near future. */ export interface Schema$GeminiInstanceConfig { /** - * Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. + * Output only. Deprecated and unused. This field will be removed in the near future. */ entitled?: boolean | null; } @@ -867,6 +924,10 @@ export namespace alloydb_v1beta { * Optional. Client connection specific configurations */ clientConnectionConfig?: Schema$ClientConnectionConfig; + /** + * Optional. The configuration for Managed Connection Pool (MCP). + */ + connectionPoolConfig?: Schema$ConnectionPoolConfig; /** * Output only. Create time stamp */ @@ -896,7 +957,7 @@ export namespace alloydb_v1beta { */ gceZone?: string | null; /** - * Optional. Configuration parameters related to the Gemini in Databases add-on. + * Optional. Deprecated and unused. This field will be removed in the near future. */ geminiConfig?: Schema$GeminiInstanceConfig; /** @@ -1362,7 +1423,7 @@ export namespace alloydb_v1beta { */ consumerNetwork?: string | null; /** - * Output only. The status of the service connection policy. + * Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. */ consumerNetworkStatus?: string | null; /** @@ -1374,7 +1435,7 @@ export namespace alloydb_v1beta { */ ipAddress?: string | null; /** - * Output only. The status of the PSC service automation connection. + * Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. */ status?: string | null; } @@ -1501,7 +1562,7 @@ export namespace alloydb_v1beta { validateOnly?: boolean | null; } /** - * Message for restoring a Cluster from a backup or another cluster at a given point in time. + * Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11 */ export interface Schema$RestoreClusterRequest { /** @@ -2596,6 +2657,10 @@ export namespace alloydb_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/analyticsadmin/v1alpha.ts b/src/apis/analyticsadmin/v1alpha.ts index 2cc29f45d1a..748b8e6c42a 100644 --- a/src/apis/analyticsadmin/v1alpha.ts +++ b/src/apis/analyticsadmin/v1alpha.ts @@ -1075,6 +1075,10 @@ export namespace analyticsadmin_v1alpha { * A snapshot of a Property resource in change history. */ property?: Schema$GoogleAnalyticsAdminV1alphaProperty; + /** + * A snapshot of a ReportingDataAnnotation resource in change history. + */ + reportingDataAnnotation?: Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotation; /** * A snapshot of a SearchAds360Link resource in change history. */ @@ -2369,6 +2373,19 @@ export namespace analyticsadmin_v1alpha { */ properties?: Schema$GoogleAnalyticsAdminV1alphaProperty[]; } + /** + * Response message for ListReportingDataAnnotation RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse { + /** + * 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 Reporting Data Annotations. + */ + reportingDataAnnotations?: Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotation[]; + } /** * Response message for ListRollupPropertySourceLinks RPC. */ @@ -2633,6 +2650,52 @@ export namespace analyticsadmin_v1alpha { */ eventEditRules?: string[] | null; } + /** + * A Reporting Data Annotation is a comment connected to certain dates for reporting data. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotation { + /** + * If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future. + */ + annotationDate?: Schema$GoogleTypeDate; + /** + * If set, the Reporting Data Annotation is for a range of dates represented by this field. + */ + annotationDateRange?: Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange; + /** + * Required. The color used for display of this Reporting Data Annotation. + */ + color?: string | null; + /** + * Optional. Description for this Reporting Data Annotation. + */ + description?: string | null; + /** + * Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id\}/reportingDataAnnotations/{reporting_data_annotation\}' Format: 'properties/123/reportingDataAnnotations/456' + */ + name?: string | null; + /** + * Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted. + */ + systemGenerated?: boolean | null; + /** + * Required. Human-readable title for this Reporting Data Annotation. + */ + title?: string | null; + } + /** + * Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange { + /** + * Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date. + */ + endDate?: Schema$GoogleTypeDate; + /** + * Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future. + */ + startDate?: Schema$GoogleTypeDate; + } /** * A link that references a source property under the parent rollup property. */ @@ -2952,6 +3015,23 @@ export namespace analyticsadmin_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$GoogleProtobufEmpty {} + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$GoogleTypeDate { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } export class Resource$Accounts { context: APIRequestContext; @@ -4902,6 +4982,7 @@ export namespace analyticsadmin_v1alpha { firebaseLinks: Resource$Properties$Firebaselinks; googleAdsLinks: Resource$Properties$Googleadslinks; keyEvents: Resource$Properties$Keyevents; + reportingDataAnnotations: Resource$Properties$Reportingdataannotations; rollupPropertySourceLinks: Resource$Properties$Rolluppropertysourcelinks; searchAds360Links: Resource$Properties$Searchads360links; subpropertyEventFilters: Resource$Properties$Subpropertyeventfilters; @@ -4939,6 +5020,8 @@ export namespace analyticsadmin_v1alpha { this.context ); this.keyEvents = new Resource$Properties$Keyevents(this.context); + this.reportingDataAnnotations = + new Resource$Properties$Reportingdataannotations(this.context); this.rollupPropertySourceLinks = new Resource$Properties$Rolluppropertysourcelinks(this.context); this.searchAds360Links = new Resource$Properties$Searchads360links( @@ -18788,6 +18871,551 @@ export namespace analyticsadmin_v1alpha { requestBody?: Schema$GoogleAnalyticsAdminV1alphaKeyEvent; } + export class Resource$Properties$Reportingdataannotations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Reporting Data Annotation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Properties$Reportingdataannotations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Properties$Reportingdataannotations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Properties$Reportingdataannotations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Reportingdataannotations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Reportingdataannotations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Properties$Reportingdataannotations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Reportingdataannotations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Properties$Reportingdataannotations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/reportingDataAnnotations' + ).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 Reporting Data Annotation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Properties$Reportingdataannotations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Properties$Reportingdataannotations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Reportingdataannotations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Reportingdataannotations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Reportingdataannotations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Properties$Reportingdataannotations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Reportingdataannotations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Properties$Reportingdataannotations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lookup a single Reporting Data Annotation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Properties$Reportingdataannotations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Properties$Reportingdataannotations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Reportingdataannotations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Reportingdataannotations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Reportingdataannotations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Properties$Reportingdataannotations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Reportingdataannotations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Reportingdataannotations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List all Reporting Data Annotations on a property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Properties$Reportingdataannotations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Properties$Reportingdataannotations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Properties$Reportingdataannotations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Properties$Reportingdataannotations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Properties$Reportingdataannotations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Properties$Reportingdataannotations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Reportingdataannotations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Reportingdataannotations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/reportingDataAnnotations' + ).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 Reporting Data Annotation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Properties$Reportingdataannotations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Properties$Reportingdataannotations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Properties$Reportingdataannotations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Properties$Reportingdataannotations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Properties$Reportingdataannotations$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Properties$Reportingdataannotations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Reportingdataannotations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Properties$Reportingdataannotations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Properties$Reportingdataannotations$Create + extends StandardParameters { + /** + * Required. The property for which to create a Reporting Data Annotation. Format: properties/property_id Example: properties/123 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotation; + } + export interface Params$Resource$Properties$Reportingdataannotations$Delete + extends StandardParameters { + /** + * Required. Resource name of the Reporting Data Annotation to delete. Format: properties/property_id/reportingDataAnnotations/reporting_data_annotation Example: properties/123/reportingDataAnnotations/456 + */ + name?: string; + } + export interface Params$Resource$Properties$Reportingdataannotations$Get + extends StandardParameters { + /** + * Required. Resource name of the Reporting Data Annotation to lookup. Format: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Example: properties/123/reportingDataAnnotations/456 + */ + name?: string; + } + export interface Params$Resource$Properties$Reportingdataannotations$List + extends StandardParameters { + /** + * Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: * 'name' * `title` * `description` * `annotation_date` * `annotation_date_range` * `color` Additionally, this API provides the following helper functions: * annotation_duration() : the duration that this annotation marks, [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto). expect a numeric representation of seconds followed by an `s` suffix. * is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the `start_date` and `end_date`. The dates are in ISO-8601 format, for example `2031-06-28`. Supported operations: * `=` : equals * `!=` : not equals * `<` : less than * `\>` : greater than * `<=` : less than or equals * `\>=` : greater than or equals * `:` : has operator * `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax) match * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax) does not match * `NOT` : Logical not * `AND` : Logical and * `OR` : Logical or Examples: 1. `title="Holiday Sale"` 2. `description=~"[Bb]ig [Gg]ame.*[Ss]ale"` 3. `is_annotation_in_range("2025-12-25", "2026-01-16") = true` 4. `annotation_duration() \>= 172800s AND title:BOGO` + */ + filter?: string; + /** + * Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListReportingDataAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReportingDataAnnotations` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Resource name of the property. Format: properties/property_id Example: properties/123 + */ + parent?: string; + } + export interface Params$Resource$Properties$Reportingdataannotations$Patch + extends StandardParameters { + /** + * Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id\}/reportingDataAnnotations/{reporting_data_annotation\}' Format: 'properties/123/reportingDataAnnotations/456' + */ + name?: string; + /** + * Optional. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotation; + } + export class Resource$Properties$Rolluppropertysourcelinks { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index b84a8a9ecc5..7b51e4d1a75 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -126,19 +126,6 @@ export namespace analyticshub_v1 { } } - /** - * Information about an associated [Analytics Hub subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions). - */ - export interface Schema$AnalyticsHubSubscriptionInfo { - /** - * Optional. The name of the associated Analytics Hub listing resource. Pattern: "projects/{project\}/locations/{location\}/dataExchanges/{data_exchange\}/listings/{listing\}" - */ - listing?: string | null; - /** - * Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project\}/locations/{location\}/subscriptions/{subscription\}" - */ - subscription?: 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. */ @@ -190,10 +177,6 @@ export namespace analyticshub_v1 { * Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. */ serviceAccountEmail?: string | null; - /** - * Output only. An output-only field that indicates whether or not the subscription can receive messages. - */ - state?: string | null; /** * Optional. The name of the table to which to write data, of the form {projectId\}.{datasetId\}.{tableId\} */ @@ -274,7 +257,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 acknowledgment deadline. + * Optional. File batching settings. If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. */ maxDuration?: string | null; /** @@ -285,10 +268,6 @@ export namespace analyticshub_v1 { * Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. */ serviceAccountEmail?: string | null; - /** - * Output only. An output-only field that indicates whether or not the subscription can receive messages. - */ - state?: string | null; /** * Optional. If set, message data will be written to Cloud Storage in text format. */ @@ -374,7 +353,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 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. + * 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. */ maxDeliveryAttempts?: number | null; } @@ -406,6 +385,10 @@ export namespace analyticshub_v1 { * Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. */ location?: string | null; + /** + * Optional. The geographic locations where the dataset should be replicated. See https://cloud.google.com/bigquery/docs/locations for supported locations. + */ + replicaLocations?: string[] | null; } export interface Schema$DestinationDatasetReference { /** @@ -519,17 +502,13 @@ export namespace analyticshub_v1 { order?: string | null; } /** - * A subscription resource. If none of `push_config`, `bigquery_config`, or `cloud_storage_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. + * Defines the destination Pub/Sub subscription. If none of `push_config`, `bigquery_config`, `cloud_storage_config`, `pubsub_export_config`, or `pubsublite_export_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. */ export interface Schema$GooglePubsubV1Subscription { /** * Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. */ ackDeadlineSeconds?: number | null; - /** - * Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub. - */ - analyticsHubSubscriptionInfo?: Schema$AnalyticsHubSubscriptionInfo; /** * Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. */ @@ -547,7 +526,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 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. + * 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. */ enableExactlyOnceDelivery?: boolean | null; /** @@ -587,17 +566,9 @@ 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 acknowledgment 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 acknowledgement deadline exceeded events for a given message. */ retryPolicy?: Schema$RetryPolicy; - /** - * Output only. An output-only field indicating whether or not the subscription can receive messages. - */ - state?: string | null; - /** - * Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. - */ - topicMessageRetentionDuration?: string | null; } /** * User-defined JavaScript function that can transform or filter a Pub/Sub message. @@ -646,6 +617,10 @@ export namespace analyticshub_v1 { * A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. */ export interface Schema$Listing { + /** + * Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. + */ + allowOnlyMetadataSharing?: boolean | null; /** * Shared dataset i.e. BigQuery dataset source. */ @@ -907,7 +882,7 @@ export namespace analyticshub_v1 { */ export interface Schema$PubSubTopicSource { /** - * Optional. Region hint on where the data might be published. Data affinity regions are modifiable. See go/regions for full listing of possible Cloud regions. + * Optional. Region hint on where the data might be published. Data affinity regions are modifiable. See https://cloud.google.com/about/locations for full listing of possible Cloud regions. */ dataAffinityRegions?: string[] | null; /** @@ -992,7 +967,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 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. + * 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. */ export interface Schema$RetryPolicy { /** @@ -2287,7 +2262,7 @@ export namespace analyticshub_v1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Create extends StandardParameters { /** - * Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes. + * Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes. */ dataExchangeId?: string; /** @@ -3332,7 +3307,7 @@ export namespace analyticshub_v1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Create extends StandardParameters { /** - * Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes. + * Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes. */ listingId?: string; /** diff --git a/src/apis/analyticshub/v1beta1.ts b/src/apis/analyticshub/v1beta1.ts index 0cc732d3600..882bcfbf1d4 100644 --- a/src/apis/analyticshub/v1beta1.ts +++ b/src/apis/analyticshub/v1beta1.ts @@ -354,6 +354,10 @@ export namespace analyticshub_v1beta1 { * A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data. */ export interface Schema$Listing { + /** + * Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable. + */ + allowOnlyMetadataSharing?: boolean | null; /** * Required. Shared dataset i.e. BigQuery dataset source. */ diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index a839157574e..0e51ae51a48 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -542,7 +542,7 @@ export namespace androiddeviceprovisioning_v1 { */ export interface Schema$FindDevicesByDeviceIdentifierRequest { /** - * Required. Required. The device identifier to search for. + * Required. Required. The device identifier to search for. If serial number is provided then case insensitive serial number matches are allowed. */ deviceIdentifier?: Schema$DeviceIdentifier; /** diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 1594bbca5a7..6bc64cc62e5 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -634,7 +634,7 @@ export namespace androidenterprise_v1 { topicName?: string | null; } /** - * An event generated when an enterprise is upgraded. **Note:** This feature is not generally available. + * An event generated when an enterprise is upgraded. */ export interface Schema$EnterpriseUpgradeEvent { /** @@ -980,7 +980,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string | null; /** - * Notifications about enterprise upgrade. **Note:** This feature is not generally available. + * Notifications about enterprise upgrade. */ enterpriseUpgradeEvent?: Schema$EnterpriseUpgradeEvent; /** @@ -2978,7 +2978,7 @@ export namespace androidenterprise_v1 { } /** - * Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource. + * Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource. *Note:* After you create a key, you might need to wait for 60 seconds or more before you perform another operation with the key. If you try to perform an operation with the key immediately after you create the key, and you receive an error, you can retry the request with exponential backoff . * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 67be314f998..6e55fd181a9 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -542,6 +542,23 @@ export namespace androidmanagement_v1 { */ versionString?: string | null; } + /** + * An admin has enabled or disabled backup service. + */ + export interface Schema$BackupServiceToggledEvent { + /** + * Package name of the admin app requesting the change. + */ + adminPackageName?: string | null; + /** + * User ID of the admin app from the which the change was requested. + */ + adminUserId?: number | null; + /** + * Whether the backup service is enabled + */ + backupServiceState?: string | null; + } /** * Batched event logs of events from the device. */ @@ -1016,6 +1033,10 @@ export namespace androidmanagement_v1 { * Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. */ export interface Schema$DeviceConnectivityManagement { + /** + * Optional. Controls whether Bluetooth sharing is allowed. + */ + bluetoothSharing?: string | null; /** * Controls Wi-Fi configuring privileges. Based on the option set, user will have either full or limited or no control in configuring Wi-Fi networks. */ @@ -1293,6 +1314,19 @@ export namespace androidmanagement_v1 { */ termsAndConditions?: Schema$TermsAndConditions[]; } + /** + * An event sent for an enterprise upgrade. An enterprise upgrade is a process that upgrades a managed Google Play Accounts enterprise to a managed Google domain. + */ + export interface Schema$EnterpriseUpgradeEvent { + /** + * The name of upgraded enterprise in the format "enterprises/{enterprise\}" + */ + enterprise?: string | null; + /** + * Output only. The upgrade state of the enterprise. + */ + upgradeState?: string | null; + } /** * Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. */ @@ -2227,6 +2261,10 @@ export namespace androidmanagement_v1 { * Account types that can't be managed by the user. */ accountTypesWithManagementDisabled?: string[] | null; + /** + * Optional. Whether bluetooth sharing is allowed. + */ + bluetoothSharing?: string | null; /** * If true, the camera is disabled on the personal profile. */ @@ -3142,6 +3180,10 @@ export namespace androidmanagement_v1 { * An app process was started. Part of SECURITY_LOGS. */ appProcessStartEvent?: Schema$AppProcessStartEvent; + /** + * An admin has enabled or disabled backup service. Part of SECURITY_LOGS. + */ + backupServiceToggledEvent?: Schema$BackupServiceToggledEvent; /** * A new root certificate was installed into the system's trusted credential storage. Part of SECURITY_LOGS. */ @@ -6573,7 +6615,7 @@ export namespace androidmanagement_v1 { export interface Params$Resource$Enterprises$Webapps$Get extends StandardParameters { /** - * The name of the web app in the form enterprises/{enterpriseId\}/webApp/{packageName\}. + * The name of the web app in the form enterprises/{enterpriseId\}/webApps/{packageName\}. */ name?: string; } diff --git a/src/apis/apigateway/v1.ts b/src/apis/apigateway/v1.ts index 6a80568b1bf..f1d54cae859 100644 --- a/src/apis/apigateway/v1.ts +++ b/src/apis/apigateway/v1.ts @@ -815,6 +815,10 @@ export namespace apigateway_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/apigateway/v1beta.ts b/src/apis/apigateway/v1beta.ts index 337f59b7fba..5b0367d9341 100644 --- a/src/apis/apigateway/v1beta.ts +++ b/src/apis/apigateway/v1beta.ts @@ -837,6 +837,10 @@ export namespace apigateway_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index ab7cb29a9ee..396dfd2f503 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -4437,6 +4437,10 @@ export namespace appengine_v1 { * Part of `name`. The resource that owns the locations collection, if applicable. */ appsId?: string; + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -6614,6 +6618,107 @@ export namespace appengine_v1 { return createAPIRequest(parameters); } } + + /** + * Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling) + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Services$Versions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Services$Versions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Services$Versions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Services$Versions$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}/services/{servicesId}/versions/{versionsId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'projectsId', + 'locationsId', + 'applicationsId', + 'servicesId', + 'versionsId', + ], + pathParams: [ + 'applicationsId', + 'locationsId', + 'projectsId', + 'servicesId', + 'versionsId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Applications$Services$Versions$Delete @@ -6639,4 +6744,36 @@ export namespace appengine_v1 { */ versionsId?: string; } + export interface Params$Resource$Projects$Locations$Applications$Services$Versions$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 resource to update. Example: apps/myapp/services/default/versions/1. + */ + projectsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + servicesId?: string; + /** + * Standard field mask for the set of fields to be updated. + */ + updateMask?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + versionsId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Version; + } } diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 4a2cc641691..5c70b127c78 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -2104,6 +2104,10 @@ export namespace appengine_v1alpha { * Part of `name`. The resource that owns the locations collection, if applicable. */ appsId?: string; + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -2553,6 +2557,10 @@ export namespace appengine_v1alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 8fdd424cb39..4049da7d604 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -4485,6 +4485,10 @@ export namespace appengine_v1beta { * Part of `name`. The resource that owns the locations collection, if applicable. */ appsId?: string; + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -6369,6 +6373,10 @@ export namespace appengine_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -6882,6 +6890,107 @@ export namespace appengine_v1beta { return createAPIRequest(parameters); } } + + /** + * Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling) + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Services$Versions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Versions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Services$Versions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Services$Versions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Services$Versions$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}/services/{servicesId}/versions/{versionsId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'projectsId', + 'locationsId', + 'applicationsId', + 'servicesId', + 'versionsId', + ], + pathParams: [ + 'applicationsId', + 'locationsId', + 'projectsId', + 'servicesId', + 'versionsId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Applications$Services$Versions$Delete @@ -6907,6 +7016,38 @@ export namespace appengine_v1beta { */ versionsId?: string; } + export interface Params$Resource$Projects$Locations$Applications$Services$Versions$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 resource to update. Example: apps/myapp/services/default/versions/1. + */ + projectsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + servicesId?: string; + /** + * Standard field mask for the set of fields to be updated. + */ + updateMask?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + versionsId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Version; + } export class Resource$Projects$Locations$Operations { context: APIRequestContext; diff --git a/src/apis/apphub/v1.ts b/src/apis/apphub/v1.ts index 3e2bebe3b3f..f14e7489d36 100644 --- a/src/apis/apphub/v1.ts +++ b/src/apis/apphub/v1.ts @@ -1266,6 +1266,10 @@ export namespace apphub_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/apphub/v1alpha.ts b/src/apis/apphub/v1alpha.ts index 68ae1624d47..ff707ad01ea 100644 --- a/src/apis/apphub/v1alpha.ts +++ b/src/apis/apphub/v1alpha.ts @@ -1316,6 +1316,10 @@ export namespace apphub_v1alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/areainsights/README.md b/src/apis/areainsights/README.md index ba9a6307180..567e918b974 100644 --- a/src/apis/areainsights/README.md +++ b/src/apis/areainsights/README.md @@ -2,7 +2,7 @@ # areainsights -> Places Insights API. +> Places Aggregate API. ## Installation diff --git a/src/apis/areainsights/v1.ts b/src/apis/areainsights/v1.ts index e6ab41a85c4..1a234baa81f 100644 --- a/src/apis/areainsights/v1.ts +++ b/src/apis/areainsights/v1.ts @@ -100,9 +100,9 @@ export namespace areainsights_v1 { } /** - * Places Insights API + * Places Aggregate API * - * Places Insights API. + * Places Aggregate API. * * @example * ```js @@ -300,7 +300,7 @@ export namespace areainsights_v1 { } /** - * Compute Insights RPC This method lets you retrieve insights about areas using a variaty of filter such as: area, place type, operating status, price level and ratings. Currently "count" and "places" insights are supported. With "count" insights you can answer questions such as "How many restaurant are located in California that are operational, are inexpensive and have an average rating of at least 4 stars" (see `insight` enum for more details). With "places" insights, you can determine which places match the requested filter. Clients can then use those place resource names to fetch more details about each individual place using the Places API. + * This method lets you retrieve insights about areas using a variety of filter such as: area, place type, operating status, price level and ratings. Currently "count" and "places" insights are supported. With "count" insights you can answer questions such as "How many restaurant are located in California that are operational, are inexpensive and have an average rating of at least 4 stars" (see `insight` enum for more details). With "places" insights, you can determine which places match the requested filter. Clients can then use those place resource names to fetch more details about each individual place using the Places API. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/artifactregistry/v1.ts b/src/apis/artifactregistry/v1.ts index d7e6ea65dbd..f0ba00a3257 100644 --- a/src/apis/artifactregistry/v1.ts +++ b/src/apis/artifactregistry/v1.ts @@ -221,7 +221,7 @@ export namespace artifactregistry_v1 { */ export interface Schema$BatchDeleteVersionsRequest { /** - * Required. The names of the versions to delete. A maximum of 10000 versions can be deleted in a batch. + * Required. The names of the versions to delete. The maximum number of versions deleted per batch is determined by the service and is dependent on the available resources in the region. */ names?: string[] | null; /** @@ -2296,6 +2296,10 @@ export namespace artifactregistry_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/artifactregistry/v1beta1.ts b/src/apis/artifactregistry/v1beta1.ts index 4a46d458b8a..96895249a48 100644 --- a/src/apis/artifactregistry/v1beta1.ts +++ b/src/apis/artifactregistry/v1beta1.ts @@ -715,6 +715,10 @@ export namespace artifactregistry_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/assuredworkloads/v1.ts b/src/apis/assuredworkloads/v1.ts index 606b913c74a..3b405764af1 100644 --- a/src/apis/assuredworkloads/v1.ts +++ b/src/apis/assuredworkloads/v1.ts @@ -158,6 +158,41 @@ export namespace assuredworkloads_v1 { */ nextPageToken?: string | null; } + /** + * Operation metadata to give request details of ApplyWorkloadUpdate. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateOperationMetadata { + /** + * Optional. The time the operation was created. + */ + action?: string | null; + /** + * Optional. Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Required. The resource name of the update + */ + updateName?: string | null; + } + /** + * Request to apply update to a workload. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest { + /** + * The action to be performed on the update. + */ + action?: string | null; + } + /** + * Response for ApplyWorkloadUpdate endpoint. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse { + /** + * The update that was applied. + */ + appliedUpdate?: Schema$GoogleCloudAssuredworkloadsV1WorkloadUpdate; + } /** * Represents move analysis results for an asset. */ @@ -196,6 +231,10 @@ export namespace assuredworkloads_v1 { */ parent?: string | null; } + /** + * Response for EnableComplianceUpdates endpoint. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse {} /** * Response for EnableResourceMonitoring endpoint. */ @@ -226,6 +265,19 @@ export namespace assuredworkloads_v1 { */ workloads?: Schema$GoogleCloudAssuredworkloadsV1Workload[]; } + /** + * Response of listing the compliance updates per workload with pagination. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse { + /** + * The next page token. Return empty if reached the last page. + */ + nextPageToken?: string | null; + /** + * The list of workload updates for a given workload. + */ + workloadUpdates?: Schema$GoogleCloudAssuredworkloadsV1WorkloadUpdate[]; + } /** * Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason. */ @@ -282,6 +334,78 @@ export namespace assuredworkloads_v1 { */ updateMask?: string | null; } + /** + * This assured workload service object is used to represent the org policy attached to a resource. It servces the same purpose as the orgpolicy.v2.Policy object but with functionality that is limited to what is supported by Assured Workloads(e.g. only one rule under one OrgPolicy object, no conditions, etc). + */ + export interface Schema$GoogleCloudAssuredworkloadsV1OrgPolicy { + /** + * The constraint name of the OrgPolicy. e.g. "constraints/gcp.resourceLocations". + */ + constraint?: string | null; + /** + * If `inherit` is true, policy rules of the lowest ancestor in the resource hierarchy chain are inherited. If it is false, policy rules are not inherited. + */ + inherit?: boolean | null; + /** + * Ignores policies set above this resource and restores to the `constraint_default` value. `reset` can only be true when `rules` is empty and `inherit` is false. + */ + reset?: boolean | null; + /** + * Resource that the OrgPolicy attaches to. Format: folders/123" projects/123". + */ + resource?: string | null; + /** + * The rule of the OrgPolicy. + */ + rule?: Schema$GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule; + } + /** + * A rule used to express this policy. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule { + /** + * ListPolicy only when all values are allowed. + */ + allowAll?: boolean | null; + /** + * ListPolicy only when all values are denied. + */ + denyAll?: boolean | null; + /** + * BooleanPolicy only. + */ + enforce?: boolean | null; + /** + * ListPolicy only when custom values are specified. + */ + values?: Schema$GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues; + } + /** + * The values allowed for a ListPolicy. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues { + /** + * List of values allowed at this resource. + */ + allowedValues?: string[] | null; + /** + * List of values denied at this resource. + */ + deniedValues?: string[] | null; + } + /** + * Represents an update for an org policy control applied on an Assured Workload resource. The inherited org policy is not considered. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1OrgPolicyUpdate { + /** + * The org policy currently applied on the assured workload resource. + */ + appliedPolicy?: Schema$GoogleCloudAssuredworkloadsV1OrgPolicy; + /** + * The suggested org policy that replaces the applied policy. + */ + suggestedPolicy?: Schema$GoogleCloudAssuredworkloadsV1OrgPolicy; + } /** * Request for restricting list of available resources in Workload environment. */ @@ -295,6 +419,15 @@ export namespace assuredworkloads_v1 { * Response for restricting the list of allowed resources. */ export interface Schema$GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse {} + /** + * The details of the update. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1UpdateDetails { + /** + * Update to one org policy, e.g. gcp.resourceLocation. + */ + orgPolicyUpdate?: Schema$GoogleCloudAssuredworkloadsV1OrgPolicyUpdate; + } /** * Workload monitoring Violation. */ @@ -673,6 +806,31 @@ export namespace assuredworkloads_v1 { */ setupStatus?: string | null; } + /** + * A workload update is a change to the workload's compliance configuration. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1WorkloadUpdate { + /** + * The time the update was created. + */ + createTime?: string | null; + /** + * The details of the update. + */ + details?: Schema$GoogleCloudAssuredworkloadsV1UpdateDetails; + /** + * Output only. Immutable. Identifier. Resource name of the WorkloadUpdate. Format: organizations/{organization\}/locations/{location\}/workloads/{workload\}/updates/{update\} + */ + name?: string | null; + /** + * Output only. The state of the update. + */ + state?: string | null; + /** + * The time the update was last updated. + */ + updateTime?: string | null; + } /** * Options to be set for the given created workload. */ @@ -993,9 +1151,13 @@ export namespace assuredworkloads_v1 { export class Resource$Organizations$Locations$Workloads { context: APIRequestContext; + updates: Resource$Organizations$Locations$Workloads$Updates; violations: Resource$Organizations$Locations$Workloads$Violations; constructor(context: APIRequestContext) { this.context = context; + this.updates = new Resource$Organizations$Locations$Workloads$Updates( + this.context + ); this.violations = new Resource$Organizations$Locations$Workloads$Violations(this.context); } @@ -1284,6 +1446,105 @@ export namespace assuredworkloads_v1 { } } + /** + * This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + enableComplianceUpdates( + params: Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates, + options: StreamMethodOptions + ): GaxiosPromise; + enableComplianceUpdates( + params?: Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates, + options?: MethodOptions + ): GaxiosPromise; + enableComplianceUpdates( + params: Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableComplianceUpdates( + params: Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableComplianceUpdates( + params: Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates, + callback: BodyResponseCallback + ): void; + enableComplianceUpdates( + callback: BodyResponseCallback + ): void; + enableComplianceUpdates( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://assuredworkloads.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:enableComplianceUpdates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Enable resource violation monitoring for a workload. * @@ -1877,7 +2138,7 @@ export namespace assuredworkloads_v1 { */ assetTypes?: string[]; /** - * Optional. Page size. If a value is not specified, the default value of 10 is used. + * Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50. */ pageSize?: number; /** @@ -1920,6 +2181,13 @@ export namespace assuredworkloads_v1 { */ name?: string; } + export interface Params$Resource$Organizations$Locations$Workloads$Enablecomplianceupdates + extends StandardParameters { + /** + * Required. The `name` field is used to identify the workload. Format: organizations/{org_id\}/locations/{location_id\}/workloads/{workload_id\} + */ + name?: string; + } export interface Params$Resource$Organizations$Locations$Workloads$Enableresourcemonitoring extends StandardParameters { /** @@ -1994,6 +2262,234 @@ export namespace assuredworkloads_v1 { requestBody?: Schema$GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest; } + export class Resource$Organizations$Locations$Workloads$Updates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * This endpoint creates a new operation to apply the given update. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + apply( + params: Params$Resource$Organizations$Locations$Workloads$Updates$Apply, + options: StreamMethodOptions + ): GaxiosPromise; + apply( + params?: Params$Resource$Organizations$Locations$Workloads$Updates$Apply, + options?: MethodOptions + ): GaxiosPromise; + apply( + params: Params$Resource$Organizations$Locations$Workloads$Updates$Apply, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + apply( + params: Params$Resource$Organizations$Locations$Workloads$Updates$Apply, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + apply( + params: Params$Resource$Organizations$Locations$Workloads$Updates$Apply, + callback: BodyResponseCallback + ): void; + apply( + callback: BodyResponseCallback + ): void; + apply( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Workloads$Updates$Apply + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Workloads$Updates$Apply; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Workloads$Updates$Apply; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://assuredworkloads.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:apply').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); + } + } + + /** + * This endpoint lists all updates for the given workload. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloads$Updates$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Workloads$Updates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Workloads$Updates$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Workloads$Updates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Workloads$Updates$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Workloads$Updates$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Workloads$Updates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Workloads$Updates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://assuredworkloads.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/updates').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$Workloads$Updates$Apply + extends StandardParameters { + /** + * Required. The resource name of the update. Format: organizations/{org_id\}/locations/{location_id\}/workloads/{workload_id\}/updates/{update_id\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest; + } + export interface Params$Resource$Organizations$Locations$Workloads$Updates$List + extends StandardParameters { + /** + * Page size. The default value is 20 and the max allowed value is 100. + */ + pageSize?: number; + /** + * Page token returned from previous request. + */ + pageToken?: string; + /** + * Required. organizations/{org_id\}/locations/{location_id\}/workloads/{workload_id\} + */ + parent?: string; + } + export class Resource$Organizations$Locations$Workloads$Violations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/assuredworkloads/v1beta1.ts b/src/apis/assuredworkloads/v1beta1.ts index 83351778705..5595be06288 100644 --- a/src/apis/assuredworkloads/v1beta1.ts +++ b/src/apis/assuredworkloads/v1beta1.ts @@ -2084,7 +2084,7 @@ export namespace assuredworkloads_v1beta1 { */ assetTypes?: string[]; /** - * Optional. Page size. If a value is not specified, the default value of 10 is used. + * Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50. */ pageSize?: number; /** diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index c4e41f0452e..fa163b93a2b 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -735,7 +735,7 @@ export namespace backupdr_v1 { */ export interface Schema$BackupRule { /** - * Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups. + * Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 186 for daily backups. Minimum value is 7 and maximum value is 366 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups. */ backupRetentionDays?: number | null; /** @@ -2466,6 +2466,10 @@ export namespace backupdr_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -6962,7 +6966,7 @@ export namespace backupdr_v1 { */ 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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500. */ pageSize?: number; /** diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index a620040a52a..8a7d45c4e55 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -1568,6 +1568,10 @@ export namespace batch_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index 002eec50e71..1f8277cd069 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -1417,15 +1417,6 @@ export namespace beyondcorp_v1 { */ unreachable?: string[] | null; } - /** - * Response message for calling ShouldThrottle - */ - export interface Schema$ShouldThrottleResponse { - /** - * Whether the port should be throttled - */ - shouldThrottle?: boolean | null; - } /** * TunnelerError is an error proto for errors returned by the connection manager. */ @@ -2520,6 +2511,10 @@ export namespace beyondcorp_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -5214,102 +5209,6 @@ export namespace beyondcorp_v1 { } } - /** - * Calls the Bouncer method ShouldThrottle to check if a request should be throttled. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options: StreamMethodOptions - ): GaxiosPromise; - shouldThrottle( - params?: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options?: MethodOptions - ): GaxiosPromise; - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - callback: BodyResponseCallback - ): void; - shouldThrottle( - callback: BodyResponseCallback - ): void; - shouldThrottle( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Appgateways$Shouldthrottle - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:shouldThrottle').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @@ -5501,21 +5400,6 @@ export namespace beyondcorp_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Appgateways$Shouldthrottle - extends StandardParameters { - /** - * Required. Name of the resource - */ - name?: string; - /** - * Optional. The port that is being throttled - */ - port?: number; - /** - * Optional. The current throughput through the port (mbps) - */ - requestedAmount?: string; - } export interface Params$Resource$Projects$Locations$Appgateways$Testiampermissions extends StandardParameters { /** diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 98d6307dd85..7f5804f1ad9 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -1089,36 +1089,6 @@ export namespace beyondcorp_v1alpha { */ verb?: string | null; } - /** - * Browser DLP Rule for a PartnerTenant - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule { - /** - * Required. The group to which this Rule should be applied to. - */ - group?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaGroup; - /** - * Output only. Unique resource name. The name is ignored when creating BrowserDlpRule. - */ - name?: string | null; - /** - * Required. The policy settings to apply. - */ - ruleSetting?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaRuleSetting; - } - /** - * Message contains the JWT encryption information for the proxy server. - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaEncryptionInfo { - /** - * Optional. Service Account for encryption key. - */ - encryptionSaEmail?: string | null; - /** - * Optional. JWK in string. - */ - jwk?: string | null; - } /** * Message to capture group information */ @@ -1132,15 +1102,6 @@ export namespace beyondcorp_v1alpha { */ id?: string | null; } - /** - * Message for response to listing BrowserDlpRules. - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaListBrowserDlpRulesResponse { - /** - * The list of BrowserDlpRule objects. - */ - browserDlpRules?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule[]; - } /** * Message for response to listing PartnerTenants. */ @@ -1154,19 +1115,6 @@ export namespace beyondcorp_v1alpha { */ partnerTenants?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant[]; } - /** - * Message for response to listing ProxyConfigs. - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaListProxyConfigsResponse { - /** - * A 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 ProxyConfig objects. - */ - proxyConfigs?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig[]; - } /** * Metadata associated with PartnerTenant and is provided by the Partner. */ @@ -1242,91 +1190,6 @@ export namespace beyondcorp_v1alpha { */ updateTime?: string | null; } - /** - * Proxy Configuration of a PartnerTenant. - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig { - /** - * Output only. Timestamp when the resource was created. - */ - createTime?: string | null; - /** - * Optional. An arbitrary caller-provided name for the ProxyConfig. Cannot exceed 64 characters. - */ - displayName?: string | null; - /** - * Optional. Information to encrypt JWT for the proxy server. - */ - encryptionInfo?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaEncryptionInfo; - /** - * Output only. ProxyConfig resource name. - */ - name?: string | null; - /** - * Optional. Protocol config data for the Proxy. - */ - proxyProtocolConfig?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig; - /** - * Required. The URI of the proxy server. - */ - proxyUri?: string | null; - /** - * Required. Routing info to direct traffic to the proxy server. - */ - routingInfo?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo; - /** - * Optional. Transport layer information to verify for the proxy server. - */ - transportInfo?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaTransportInfo; - /** - * Output only. Timestamp when the resource was last modified. - */ - updateTime?: string | null; - } - /** - * The protocol data that specifies how to communicate with Partner's Proxy. - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig { - /** - * Optional. Untyped property bag to be sent back to the proxy using client specific mechanism. - */ - metadata?: {[key: string]: string} | null; - } - /** - * Message contains the routing information to direct traffic to the proxy server. - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo { - /** - * Required. Proxy Auto-Configuration (PAC) URI. - */ - pacUri?: string | null; - } - /** - * Message to capture settings for a BrowserDlpRule - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaRuleSetting { - /** - * Required. Immutable. The type of the Setting. . - */ - type?: string | null; - /** - * Required. The value of the Setting. - */ - value?: {[key: string]: any} | null; - } - /** - * Message contains the transport layer information to verify the proxy server. - */ - export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaTransportInfo { - /** - * Required. PEM encoded CA certificate associated with the proxy server certificate. - */ - serverCaCertPem?: string | null; - /** - * Optional. PEM encoded CA certificate associated with the certificate used by proxy server for SSL decryption. - */ - sslDecryptCaCertPem?: string | null; - } /** * Represents the metadata of the long-running operation. */ @@ -2191,15 +2054,6 @@ export namespace beyondcorp_v1alpha { */ email?: string | null; } - /** - * Response message for calling ShouldThrottle - */ - export interface Schema$ShouldThrottleResponse { - /** - * Whether the port should be throttled - */ - shouldThrottle?: boolean | null; - } /** * TunnelerError is an error proto for errors returned by the connection manager. */ @@ -2297,102 +2151,6 @@ export namespace beyondcorp_v1alpha { ); } - /** - * Creates a new BeyondCorp Enterprise partnerTenant in a given organization and can only be called by onboarded BeyondCorp Enterprise 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. - */ - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/partnerTenants').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 PartnerTenant. * @@ -2680,65 +2438,65 @@ export namespace beyondcorp_v1alpha { } /** - * Updates a single PartnerTenant. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Patch, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Patch, + testIamPermissions( + params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Patch, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Patch, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Patch, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - patch( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Patch - | 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$Patch; + {}) 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$Patch; + {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions; options = {}; } @@ -2751,146 +2509,37 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Delete + extends StandardParameters { /** - * 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$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - 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 + '/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$Organizations$Locations$Global$Partnertenants$Create - extends StandardParameters { - /** - * Required. The resource name of the parent organization using the form: `organizations/{organization_id\}/locations/global` - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Delete - extends StandardParameters { - /** - * Required. Name of the resource. + * Required. Name of the resource. */ name?: string; /** @@ -2928,1141 +2577,85 @@ export namespace beyondcorp_v1alpha { */ parent?: string; } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Patch - extends StandardParameters { - /** - * Output only. Unique resource name of the PartnerTenant. The name is ignored when creating PartnerTenant. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Required. Field mask is used to specify the fields to be overwritten in the PartnerTenant 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. Mutable fields: display_name, partner_metadata, group_information. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant; - } 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; - } - - /** - * Creates a new BrowserDlpRule in a given organization and PartnerTenant. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/browserDlpRules').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 existing BrowserDlpRule. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Partnertenants$Browserdlprules$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single BrowserDlpRule. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Partnertenants$Browserdlprules$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists BrowserDlpRules for PartnerTenant in a given organization. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/browserDlpRules').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 an existing BrowserDlpRule in a given organization and PartnerTenant. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 + '/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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Create - extends StandardParameters { - /** - * Required. The resource name of the BrowserDlpRule parent using the form: `organizations/{organization_id\}/locations/global/partnerTenants/{partner_tenant_id\}` - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore 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; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Delete - extends StandardParameters { - /** - * Required. The resource name of the BrowserDlpRule using the form: `organizations/{organization_id\}/locations/global/partnerTenants/{partner_tenant_id\}/browserDlpRules/{browser_dlp_rule_id\}` - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Get - extends StandardParameters { - /** - * Required. The resource name of the BrowserDlpRule using the form: `organizations/{organization_id\}/locations/global/partnerTenants/{partner_tenant_id\}/browserDlpRules/{browser_dlp_rule_id\}` - */ - name?: string; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$List - extends StandardParameters { - /** - * Required. The parent partnerTenant to which the BrowserDlpRules belong. Format: `organizations/{organization_id\}/locations/global/partnerTenants/{partner_tenant_id\}` - */ - parent?: string; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Patch - extends StandardParameters { - /** - * Output only. Unique resource name. The name is ignored when creating BrowserDlpRule. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Required. Supported fields include: rule_setting.value.*, group.id/group.email. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule; - } - 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; - } - - /** - * Creates a new BeyondCorp Enterprise ProxyConfig in a given organization and PartnerTenant. Can only be called by on onboarded Beyondcorp Enterprise 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. - */ - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/proxyConfigs').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 ProxyConfig. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Partnertenants$Proxyconfigs$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single ProxyConfig. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Partnertenants$Proxyconfigs$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - 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 - ); - } - } - - /** - * Lists ProxyConfigs for PartnerTenant in a given organization. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + resource?: string; - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/proxyConfigs').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 - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Updates a single proxy config. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Patch, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Patch, + testIamPermissions( + params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Patch, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Patch, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Patch, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - patch( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Patch - | 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$Patch; + {}) 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$Patch; + {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions; options = {}; } @@ -4075,26 +2668,51 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$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. @@ -4195,83 +2813,6 @@ export namespace beyondcorp_v1alpha { } } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Create - extends StandardParameters { - /** - * Required. The resource name of the parent PartnerTenant using the form: `organizations/{organization_id\}/locations/global/partnerTenants/{partner_tenant_id\}` - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore 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; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Delete - extends StandardParameters { - /** - * Required. Name of the resource. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ProxyConfig using the form: `organizations/{organization_id\}/locations/global/partnerTenants/{partner_tenant_id\}/proxyConfigs/{proxy_config_id\}` - */ - name?: string; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$List - extends StandardParameters { - /** - * Optional. A filter specifying constraints of a list operation. All fields in the ProxyConfig message are supported. For example, the following query will return the ProxyConfigs with displayName "test-config" organizations/${ORG_ID\}/locations/global/partnerTenants/${PARTNER_TENANT_ID\}/proxyConfigs?filter=displayName="test-config" Nested fields are also supported. The follow query will return ProxyConfigs with pacUri "example.com/pac.pac" organizations/${ORG_ID\}/locations/global/partnerTenants/${PARTNER_TENANT_ID\}/proxyConfigs?filter=routingInfo.pacUri="example.com/pac.pac" For more information, please refer to https://google.aip.dev/160. - */ - filter?: string; - /** - * Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. - */ - orderBy?: string; - /** - * Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous ListProxyConfigsRequest, if any. - */ - pageToken?: string; - /** - * Required. The parent organization to which the ProxyConfigs belong. Format: `organizations/{organization_id\}/locations/global/partnerTenants/{partner_tenant_id\}` - */ - parent?: string; - } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Patch - extends StandardParameters { - /** - * Output only. ProxyConfig resource name. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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; - /** - * Required. Mutable fields include: display_name, proxy_uri, routing_info, transport_info, encryption_info. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig; - } export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Testiampermissions extends StandardParameters { /** @@ -6018,6 +4559,10 @@ export namespace beyondcorp_v1alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -8711,102 +7256,6 @@ export namespace beyondcorp_v1alpha { } } - /** - * Calls the Bouncer method ShouldThrottle to check if a request should be throttled. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options: StreamMethodOptions - ): GaxiosPromise; - shouldThrottle( - params?: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options?: MethodOptions - ): GaxiosPromise; - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - shouldThrottle( - params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, - callback: BodyResponseCallback - ): void; - shouldThrottle( - callback: BodyResponseCallback - ): void; - shouldThrottle( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Appgateways$Shouldthrottle - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}:shouldThrottle').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @@ -8998,21 +7447,6 @@ export namespace beyondcorp_v1alpha { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Appgateways$Shouldthrottle - extends StandardParameters { - /** - * Required. Name of the resource - */ - name?: string; - /** - * Optional. The port that is being throttled - */ - port?: number; - /** - * Optional. The current throughput through the port (mbps) - */ - requestedAmount?: string; - } export interface Params$Resource$Projects$Locations$Appgateways$Testiampermissions extends StandardParameters { /** diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index a2b5085b03f..954825b4179 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -467,7 +467,7 @@ export namespace bigquery_v2 { biEngineReasons?: Schema$BiEngineReason[]; } /** - * Configuration for BigLake managed tables. + * Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) */ export interface Schema$BigLakeConfiguration { /** @@ -4511,7 +4511,7 @@ export namespace bigquery_v2 { } export interface Schema$Table { /** - * Optional. Specifies the configuration of a BigLake managed table. + * Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. */ biglakeConfiguration?: Schema$BigLakeConfiguration; /** diff --git a/src/apis/bigquerydatapolicy/v1.ts b/src/apis/bigquerydatapolicy/v1.ts index 70f8b789d45..852ef9e82c4 100644 --- a/src/apis/bigquerydatapolicy/v1.ts +++ b/src/apis/bigquerydatapolicy/v1.ts @@ -193,7 +193,7 @@ export namespace bigquerydatapolicy_v1 { */ dataPolicyId?: string | null; /** - * Type of data policy. + * Required. Data policy type. Type of data policy. */ dataPolicyType?: string | null; /** diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index 84529e2e617..0b91bdf039f 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -1131,7 +1131,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Datasources$Checkvalidcreds extends StandardParameters { /** - * Required. The data source in the form: `projects/{project_id\}/dataSources/{data_source_id\}` or `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}`. + * Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/dataSources/{data_source_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}` */ name?: string; @@ -1143,7 +1143,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Datasources$Get extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/dataSources/{data_source_id\}` or `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/dataSources/{data_source_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}` */ name?: string; } @@ -1557,6 +1557,10 @@ export namespace bigquerydatatransfer_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -1874,7 +1878,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Datasources$Checkvalidcreds extends StandardParameters { /** - * Required. The data source in the form: `projects/{project_id\}/dataSources/{data_source_id\}` or `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}`. + * Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/dataSources/{data_source_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}` */ name?: string; @@ -1886,7 +1890,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Datasources$Get extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/dataSources/{data_source_id\}` or `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/dataSources/{data_source_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/dataSources/{data_source_id\}` */ name?: string; } @@ -2461,7 +2465,7 @@ export namespace bigquerydatatransfer_v1 { } /** - * Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. + * Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2587,14 +2591,14 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Delete extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` + * Required. The name of the resource to delete. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Transferconfigs$Get extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ name?: string; } @@ -2613,7 +2617,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id\}` or `projects/{project_id\}/locations/{location_id\}` + * Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id\} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id\}/locations/{location_id\}` */ parent?: string; } @@ -2648,7 +2652,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Scheduleruns extends StandardParameters { /** - * Required. Transfer configuration name in the form: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}`. + * Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ parent?: string; @@ -2660,7 +2664,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Startmanualruns extends StandardParameters { /** - * Required. Transfer configuration name in the form: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}`. + * Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ parent?: string; @@ -2951,14 +2955,14 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Delete extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Get extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` */ name?: string; } @@ -2973,7 +2977,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}`. + * Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ parent?: string; /** @@ -3103,7 +3107,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Transfer run name in the form: `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` + * Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` */ parent?: string; } @@ -3658,7 +3662,7 @@ export namespace bigquerydatatransfer_v1 { } /** - * Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. + * Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3783,14 +3787,14 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Delete extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` + * Required. The name of the resource to delete. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ name?: string; } export interface Params$Resource$Projects$Transferconfigs$Get extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ name?: string; } @@ -3809,7 +3813,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id\}` or `projects/{project_id\}/locations/{location_id\}` + * Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be `US` and `parent` should be in the following form: * `projects/{project_id\} If you are using the regionalized method, `parent` should be in the following form: * `projects/{project_id\}/locations/{location_id\}` */ parent?: string; } @@ -3844,7 +3848,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Scheduleruns extends StandardParameters { /** - * Required. Transfer configuration name in the form: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}`. + * Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ parent?: string; @@ -3856,7 +3860,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Startmanualruns extends StandardParameters { /** - * Required. Transfer configuration name in the form: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}`. + * Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ parent?: string; @@ -4142,14 +4146,14 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Runs$Delete extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` */ name?: string; } export interface Params$Resource$Projects$Transferconfigs$Runs$Get extends StandardParameters { /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` + * Required. The name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` */ name?: string; } @@ -4164,7 +4168,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id\}/transferConfigs/{config_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}`. + * Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}` */ parent?: string; /** @@ -4294,7 +4298,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Transfer run name in the form: `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` or `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` + * Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following form: * `projects/{project_id\}/transferConfigs/{config_id\}/runs/{run_id\}` If you are using the regionalized method, the name should be in the following form: * `projects/{project_id\}/locations/{location_id\}/transferConfigs/{config_id\}/runs/{run_id\}` */ parent?: string; } diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index c582085dcd5..90134fb2afd 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -158,7 +158,7 @@ export namespace bigqueryreservation_v1 { */ currentSlots?: string | null; /** - * Number of slots to be scaled when needed. + * Optional. Number of slots to be scaled when needed. */ maxSlots?: string | null; } @@ -327,11 +327,11 @@ export namespace bigqueryreservation_v1 { */ export interface Schema$Reservation { /** - * The configuration parameters for the auto scaling feature. + * Optional. The configuration parameters for the auto scaling feature. */ autoscale?: Schema$Autoscale; /** - * Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI. + * Optional. Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target job concurrency in the Information Schema, DDL and BigQuery CLI. */ concurrency?: string | null; /** @@ -339,11 +339,11 @@ export namespace bigqueryreservation_v1 { */ creationTime?: string | null; /** - * Edition of the reservation. + * Optional. Edition of the reservation. */ edition?: string | null; /** - * If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. + * Optional. If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. */ ignoreIdleSlots?: boolean | null; /** @@ -359,7 +359,7 @@ export namespace bigqueryreservation_v1 { */ multiRegionAuxiliary?: boolean | null; /** - * The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. + * Identifier. The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. */ name?: string | null; /** @@ -375,7 +375,7 @@ export namespace bigqueryreservation_v1 { */ 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`. + * Optional. 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; /** @@ -383,7 +383,7 @@ export namespace bigqueryreservation_v1 { */ secondaryLocation?: string | null; /** - * Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. + * Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. */ slotCapacity?: string | null; /** @@ -2281,7 +2281,7 @@ export namespace bigqueryreservation_v1 { export interface Params$Resource$Projects$Locations$Reservations$Patch extends StandardParameters { /** - * The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. + * Identifier. The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. */ name?: string; /** diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 8a3e9983045..c8310f79059 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -147,7 +147,7 @@ export namespace bigtableadmin_v2 { */ multiClusterRoutingUseAny?: Schema$MultiClusterRoutingUseAny; /** - * The unique name of the app profile. Values are of the form `projects/{project\}/instances/{instance\}/appProfiles/_a-zA-Z0-9*`. + * The unique name of the app profile, up to 50 characters long. Values are of the form `projects/{project\}/instances/{instance\}/appProfiles/_a-zA-Z0-9*`. */ name?: string | null; /** @@ -1328,6 +1328,32 @@ export namespace bigtableadmin_v2 { */ nextPageToken?: string | null; } + /** + * Response message for BigtableInstanceAdmin.ListLogicalViews. + */ + export interface Schema$ListLogicalViewsResponse { + /** + * The list of requested logical views. + */ + logicalViews?: Schema$LogicalView[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for BigtableInstanceAdmin.ListMaterializedViews. + */ + export interface Schema$ListMaterializedViewsResponse { + /** + * The list of requested materialized views. + */ + materializedViews?: Schema$MaterializedView[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * The response message for Operations.ListOperations. */ @@ -1383,6 +1409,10 @@ export namespace bigtableadmin_v2 { * A SQL logical view object that can be referenced in SQL queries. */ export interface Schema$LogicalView { + /** + * Optional. Set to true to make the LogicalView protected against deletion. + */ + deletionProtection?: boolean | null; /** * 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. */ @@ -1740,6 +1770,10 @@ export namespace bigtableadmin_v2 { * Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore. */ restoreInfo?: Schema$RestoreInfo; + /** + * The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {\} \} \} \} fields { field_name: "date" type { string { encoding: utf8_bytes {\} \} \} \} fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {\} \} \} \} encoding { delimited_bytes { delimiter: "#" \} \} \} The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | \------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported. + */ + rowKeySchema?: Schema$GoogleBigtableAdminV2TypeStruct; /** * Output only. Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above. */ @@ -3680,7 +3714,7 @@ export namespace bigtableadmin_v2 { */ ignoreWarnings?: boolean; /** - * The unique name of the app profile. Values are of the form `projects/{project\}/instances/{instance\}/appProfiles/_a-zA-Z0-9*`. + * The unique name of the app profile, up to 50 characters long. Values are of the form `projects/{project\}/instances/{instance\}/appProfiles/_a-zA-Z0-9*`. */ name?: string; /** @@ -5375,58 +5409,57 @@ export namespace bigtableadmin_v2 { } /** - * Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. + * Creates a logical view within an 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. */ - getIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, + create( + params: Params$Resource$Projects$Instances$Logicalviews$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, + create( + params?: Params$Resource$Projects$Instances$Logicalviews$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Instances$Logicalviews$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Instances$Logicalviews$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Instances$Logicalviews$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Instances$Logicalviews$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Instances$Logicalviews$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Instances$Logicalviews$Getiampolicy; + {}) as Params$Resource$Projects$Instances$Logicalviews$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Instances$Logicalviews$Getiampolicy; + params = {} as Params$Resource$Projects$Instances$Logicalviews$Create; options = {}; } @@ -5440,7 +5473,7 @@ export namespace bigtableadmin_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v2/{+parent}/logicalViews').replace( /([^:]\/)\/+/g, '$1' ), @@ -5450,73 +5483,72 @@ export namespace bigtableadmin_v2 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on an instance resource. Replaces any existing policy. + * Deletes a logical view from an 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. */ - setIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + delete( + params: Params$Resource$Projects$Instances$Logicalviews$Delete, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + delete( + params?: Params$Resource$Projects$Instances$Logicalviews$Delete, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Instances$Logicalviews$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Instances$Logicalviews$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Instances$Logicalviews$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Instances$Logicalviews$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Instances$Logicalviews$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Instances$Logicalviews$Setiampolicy; + {}) as Params$Resource$Projects$Instances$Logicalviews$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Instances$Logicalviews$Setiampolicy; + params = {} as Params$Resource$Projects$Instances$Logicalviews$Delete; options = {}; } @@ -5530,90 +5562,79 @@ export namespace bigtableadmin_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that the caller has on the specified instance resource. + * Gets information about a logical view. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + get( + params: Params$Resource$Projects$Instances$Logicalviews$Get, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Instances$Logicalviews$Testiampermissions, + get( + params?: Params$Resource$Projects$Instances$Logicalviews$Get, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Instances$Logicalviews$Testiampermissions, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Instances$Logicalviews$Get, 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 + get( + params: Params$Resource$Projects$Instances$Logicalviews$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Instances$Logicalviews$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Instances$Logicalviews$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Instances$Logicalviews$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$Instances$Logicalviews$Testiampermissions; + {}) as Params$Resource$Projects$Instances$Logicalviews$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Instances$Logicalviews$Testiampermissions; + params = {} as Params$Resource$Projects$Instances$Logicalviews$Get; options = {}; } @@ -5627,73 +5648,26 @@ export namespace bigtableadmin_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$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. @@ -5704,31 +5678,31 @@ export namespace bigtableadmin_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + params?: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy(callback: BodyResponseCallback): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Instances$Materializedviews$Getiampolicy + | Params$Resource$Projects$Instances$Logicalviews$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5741,13 +5715,13 @@ export namespace bigtableadmin_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Instances$Materializedviews$Getiampolicy; + {}) as Params$Resource$Projects$Instances$Logicalviews$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Instances$Materializedviews$Getiampolicy; + {} as Params$Resource$Projects$Instances$Logicalviews$Getiampolicy; options = {}; } @@ -5786,33 +5760,1048 @@ export namespace bigtableadmin_v2 { } /** - * Sets the access control policy on an instance resource. Replaces any existing policy. + * Lists information about logical views in an 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. */ - setIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + list( + params: Params$Resource$Projects$Instances$Logicalviews$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + list( + params?: Params$Resource$Projects$Instances$Logicalviews$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Instances$Logicalviews$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Instances$Logicalviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + list( + params: Params$Resource$Projects$Instances$Logicalviews$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Logicalviews$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Logicalviews$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Logicalviews$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/logicalViews').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 logical view within an 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. + */ + patch( + params: Params$Resource$Projects$Instances$Logicalviews$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Instances$Logicalviews$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Instances$Logicalviews$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Logicalviews$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Logicalviews$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Logicalviews$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Logicalviews$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Logicalviews$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.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); + } + } + + /** + * 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$Create + extends StandardParameters { + /** + * Required. The ID to use for the logical view, which will become the final component of the logical view's resource name. + */ + logicalViewId?: string; + /** + * Required. The parent instance where this logical view will be created. Format: `projects/{project\}/instances/{instance\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogicalView; + } + export interface Params$Resource$Projects$Instances$Logicalviews$Delete + extends StandardParameters { + /** + * Optional. The current etag of the logical view. If an etag is provided and does not match the current etag of the logical view, deletion will be blocked and an ABORTED error will be returned. + */ + etag?: string; + /** + * Required. The unique name of the logical view to be deleted. Format: `projects/{project\}/instances/{instance\}/logicalViews/{logical_view\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Logicalviews$Get + extends StandardParameters { + /** + * Required. The unique name of the requested logical view. Values are of the form `projects/{project\}/instances/{instance\}/logicalViews/{logical_view\}`. + */ + name?: string; + } + 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$List + extends StandardParameters { + /** + * Optional. The maximum number of logical views to return. The service may return fewer than this value + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListLogicalViews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLogicalViews` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The unique name of the instance for which the list of logical views is requested. Values are of the form `projects/{project\}/instances/{instance\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Instances$Logicalviews$Patch + extends StandardParameters { + /** + * Identifier. The unique name of the logical view. Format: `projects/{project\}/instances/{instance\}/logicalViews/{logical_view\}` + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogicalView; + } + 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; + } + + /** + * Creates a materialized view within an 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. + */ + create( + params: Params$Resource$Projects$Instances$Materializedviews$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Instances$Materializedviews$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Instances$Materializedviews$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Materializedviews$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Materializedviews$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Materializedviews$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/materializedViews').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 materialized view from an 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. + */ + delete( + params: Params$Resource$Projects$Instances$Materializedviews$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Instances$Materializedviews$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Instances$Materializedviews$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Materializedviews$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Materializedviews$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Materializedviews$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.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 materialized view. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Instances$Materializedviews$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Instances$Materializedviews$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Instances$Materializedviews$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Materializedviews$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Materializedviews$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Materializedviews$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.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); + } + } + + /** + * 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); + } + } + + /** + * Lists information about materialized views in an 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. + */ + list( + params: Params$Resource$Projects$Instances$Materializedviews$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Instances$Materializedviews$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Instances$Materializedviews$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Materializedviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Materializedviews$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Materializedviews$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/materializedViews').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 materialized view within an 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. + */ + patch( + params: Params$Resource$Projects$Instances$Materializedviews$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Instances$Materializedviews$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Instances$Materializedviews$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Materializedviews$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Materializedviews$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Materializedviews$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.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); + } + } + + /** + * 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; @@ -5973,6 +6962,40 @@ export namespace bigtableadmin_v2 { } } + export interface Params$Resource$Projects$Instances$Materializedviews$Create + extends StandardParameters { + /** + * Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name. + */ + materializedViewId?: string; + /** + * Required. The parent instance where this materialized view will be created. Format: `projects/{project\}/instances/{instance\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MaterializedView; + } + export interface Params$Resource$Projects$Instances$Materializedviews$Delete + extends StandardParameters { + /** + * Optional. The current etag of the materialized view. If an etag is provided and does not match the current etag of the materialized view, deletion will be blocked and an ABORTED error will be returned. + */ + etag?: string; + /** + * Required. The unique name of the materialized view to be deleted. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Materializedviews$Get + extends StandardParameters { + /** + * Required. The unique name of the requested materialized view. Values are of the form `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}`. + */ + name?: string; + } export interface Params$Resource$Projects$Instances$Materializedviews$Getiampolicy extends StandardParameters { /** @@ -5985,6 +7008,37 @@ export namespace bigtableadmin_v2 { */ requestBody?: Schema$GetIamPolicyRequest; } + export interface Params$Resource$Projects$Instances$Materializedviews$List + extends StandardParameters { + /** + * Optional. The maximum number of materialized views to return. The service may return fewer than this value + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListMaterializedViews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMaterializedViews` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The unique name of the instance for which the list of materialized views is requested. Values are of the form `projects/{project\}/instances/{instance\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Instances$Materializedviews$Patch + extends StandardParameters { + /** + * Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MaterializedView; + } export interface Params$Resource$Projects$Instances$Materializedviews$Setiampolicy extends StandardParameters { /** @@ -7398,6 +8452,10 @@ export namespace bigtableadmin_v2 { } export interface Params$Resource$Projects$Instances$Tables$Patch extends StandardParameters { + /** + * Optional. If true, ignore safety checks when updating the table. + */ + ignoreWarnings?: boolean; /** * The unique name of the table. Values are of the form `projects/{project\}/instances/{instance\}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` */ @@ -8410,6 +9468,10 @@ export namespace bigtableadmin_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/blockchainnodeengine/v1.ts b/src/apis/blockchainnodeengine/v1.ts index a92b1d23ff8..dc3cf4142c1 100644 --- a/src/apis/blockchainnodeengine/v1.ts +++ b/src/apis/blockchainnodeengine/v1.ts @@ -153,7 +153,7 @@ export namespace blockchainnodeengine_v1 { */ name?: string | null; /** - * Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect. + * Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: These nodes are deprecated, please use public endpoints instead. */ privateServiceConnectEnabled?: boolean | null; /** @@ -640,6 +640,10 @@ export namespace blockchainnodeengine_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index bc1a7160b40..aa3247a4c34 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -112,6 +112,7 @@ export namespace chat_v1 { */ export class Chat { context: APIRequestContext; + customEmojis: Resource$Customemojis; media: Resource$Media; spaces: Resource$Spaces; users: Resource$Users; @@ -122,6 +123,7 @@ export namespace chat_v1 { google, }; + this.customEmojis = new Resource$Customemojis(this.context); this.media = new Resource$Media(this.context); this.spaces = new Resource$Spaces(this.context); this.users = new Resource$Users(this.context); @@ -491,9 +493,25 @@ export namespace chat_v1 { space?: Schema$Space; } /** - * Represents a custom emoji. + * Represents a [custom emoji](https://support.google.com/chat/answer/12800149). */ export interface Schema$CustomEmoji { + /** + * Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:` + */ + emojiName?: string | null; + /** + * Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji\}` + */ + name?: string | null; + /** + * Optional. Input only. Payload data. Required when the custom emoji is created. + */ + payload?: Schema$CustomEmojiPayload; + /** + * Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created. + */ + temporaryImageUri?: string | null; /** * Output only. Unique key for the custom emoji resource. */ @@ -508,6 +526,19 @@ export namespace chat_v1 { */ customEmoji?: Schema$CustomEmoji; } + /** + * Payload data for the custom emoji. + */ + export interface Schema$CustomEmojiPayload { + /** + * Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change. + */ + fileContent?: string | null; + /** + * Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`. + */ + filename?: string | null; + } /** * Date input values. */ @@ -1396,13 +1427,11 @@ export namespace chat_v1 { * For multiselect menus, a text description or label that's displayed below the item's `text` field. */ bottomText?: string | null; + materialIcon?: Schema$GoogleAppsCardV1MaterialIcon; /** * Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item. */ selected?: boolean | null; - /** - * For multiselect menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`. - */ startIconUri?: string | null; /** * The text that identifies or describes the item to users. @@ -1735,6 +1764,19 @@ export namespace chat_v1 { */ topLabel?: string | null; } + /** + * A response to list custom emojis. + */ + export interface Schema$ListCustomEmojisResponse { + /** + * Unordered list. List of custom emojis. + */ + customEmojis?: Schema$CustomEmoji[]; + /** + * A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response to list memberships of the space. */ @@ -2762,6 +2804,393 @@ export namespace chat_v1 { textParagraph?: Schema$TextParagraph; } + export class Resource$Customemojis { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). 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. + */ + create( + params: Params$Resource$Customemojis$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Customemojis$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Customemojis$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Customemojis$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Customemojis$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Customemojis$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customemojis$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customemojis$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://chat.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/customEmojis').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). 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. + */ + delete( + params: Params$Resource$Customemojis$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Customemojis$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Customemojis$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Customemojis$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Customemojis$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Customemojis$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customemojis$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customemojis$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). 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$Customemojis$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Customemojis$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customemojis$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customemojis$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customemojis$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customemojis$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customemojis$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customemojis$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); + } + } + + /** + * Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). 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. + */ + list( + params: Params$Resource$Customemojis$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Customemojis$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customemojis$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customemojis$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customemojis$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Customemojis$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customemojis$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customemojis$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://chat.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/customEmojis').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$Customemojis$Create + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$CustomEmoji; + } + export interface Params$Resource$Customemojis$Delete + extends StandardParameters { + /** + * Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji\}` You can use the emoji name as an alias for `{customEmoji\}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji. + */ + name?: string; + } + export interface Params$Resource$Customemojis$Get extends StandardParameters { + /** + * Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji\}` You can use the emoji name as an alias for `{customEmoji\}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji. + */ + name?: string; + } + export interface Params$Resource$Customemojis$List + extends StandardParameters { + /** + * Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator("users/me")` and `NOT creator("users/me")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: ``` creator("users/me") ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error. + */ + filter?: string; + /** + * Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200. + */ + pageSize?: number; + /** + * Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results. + */ + pageToken?: string; + } + export class Resource$Media { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -3986,7 +4415,7 @@ export namespace chat_v1 { } /** - * Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. + * Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the application must be the space creator. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4353,7 +4782,7 @@ export namespace chat_v1 { export interface Params$Resource$Spaces$Members$Delete extends StandardParameters { /** - * Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope and `spaces/{space\}/members/{member\}` format. You can use the email as an alias for `{member\}`. For example, `spaces/{space\}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space\}/members/app` format. Format: `spaces/{space\}/members/{member\}` or `spaces/{space\}/members/app`. + * Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space\}/members/{member\}` format. You can use the email as an alias for `{member\}`. For example, `spaces/{space\}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space\}/members/app` format. Format: `spaces/{space\}/members/{member\}` or `spaces/{space\}/members/app`. */ name?: string; /** @@ -5465,7 +5894,7 @@ export namespace chat_v1 { export interface Params$Resource$Spaces$Messages$Reactions$List extends StandardParameters { /** - * Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = "🙂" OR emoji.unicode = "👍"` and `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = "users/{user\}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid\}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}" emoji.unicode = "🙂" AND user.name = "users/{user\}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}") AND user.name = "users/{user\}" ``` The following queries are invalid: ``` emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid\}" emoji.unicode = "🙂" OR user.name = "users/{user\}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}" OR user.name = "users/{user\}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}" AND user.name = "users/{user\}" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. + * Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = "🙂" OR emoji.unicode = "👍"` and `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = "users/{user\}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid\}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}" emoji.unicode = "🙂" AND user.name = "users/{user\}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}") AND user.name = "users/{user\}" ``` The following queries are invalid: ``` emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid\}" emoji.unicode = "🙂" OR user.name = "users/{user\}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}" OR user.name = "users/{user\}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid\}" AND user.name = "users/{user\}" ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error. */ filter?: string; /** diff --git a/src/apis/chromemanagement/v1.ts b/src/apis/chromemanagement/v1.ts index 9cb023956e5..eb3ee46a169 100644 --- a/src/apis/chromemanagement/v1.ts +++ b/src/apis/chromemanagement/v1.ts @@ -5030,7 +5030,7 @@ export namespace chromemanagement_v1 { */ appId?: string; /** - * Type of the app. + * Type of the app. Optional. If not provided, an app type will be inferred from the format of the app ID. */ appType?: string; /** diff --git a/src/apis/chromepolicy/v1.ts b/src/apis/chromepolicy/v1.ts index 563cae04ec2..393f409facc 100644 --- a/src/apis/chromepolicy/v1.ts +++ b/src/apis/chromepolicy/v1.ts @@ -385,7 +385,7 @@ export namespace chromepolicy_v1 { updateMask?: string | null; } /** - * A network setting contains network configurations. + * A network setting contains network configurations. It adheres to the PolicyAPI formats defined under the namespace chrome.networks.{wifi/ethernet/cellular/vpn\}.Details */ export interface Schema$GoogleChromePolicyVersionsV1NetworkSetting { /** @@ -854,6 +854,10 @@ export namespace chromepolicy_v1 { name?: string | null; nestedType?: Schema$Proto2DescriptorProto[]; oneofDecl?: Schema$Proto2OneofDescriptorProto[]; + /** + * Support for `export` and `local` keywords on enums. + */ + visibility?: string | null; } /** * Describes an enum type. @@ -861,6 +865,10 @@ export namespace chromepolicy_v1 { export interface Schema$Proto2EnumDescriptorProto { name?: string | null; value?: Schema$Proto2EnumValueDescriptorProto[]; + /** + * Support for `export` and `local` keywords on enums. + */ + visibility?: string | null; } /** * Describes a value within an enum. @@ -918,6 +926,10 @@ export namespace chromepolicy_v1 { * file name, relative to root of source tree */ name?: string | null; + /** + * Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above. + */ + optionDependency?: string[] | null; /** * e.g. "foo", "foo.bar", etc. */ diff --git a/src/apis/chromeuxreport/v1.ts b/src/apis/chromeuxreport/v1.ts index 03c54c2534d..c4e8a6aac6b 100644 --- a/src/apis/chromeuxreport/v1.ts +++ b/src/apis/chromeuxreport/v1.ts @@ -282,6 +282,10 @@ export namespace chromeuxreport_v1 { * Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience history record. */ export interface Schema$QueryHistoryRequest { + /** + * The number of collection periods to return. If not specified, the default is 25. If present, must be in the range [1, 40]. + */ + collectionPeriodCount?: number | null; /** * The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned. */ diff --git a/src/apis/civicinfo/v2.ts b/src/apis/civicinfo/v2.ts index 2aadfc4d6d8..7b404c958cd 100644 --- a/src/apis/civicinfo/v2.ts +++ b/src/apis/civicinfo/v2.ts @@ -128,18 +128,160 @@ export namespace civicinfo_v2 { } } + export interface Schema$CivicinfoApiprotosV2DivisionByAddressResponse { + divisions?: { + [key: string]: Schema$CivicinfoSchemaV2GeographicDivision; + } | null; + /** + * The normalized version of the requested address. + */ + normalizedInput?: Schema$CivicinfoSchemaV2SimpleAddressType; + } + /** + * The result of a division search query. + */ + export interface Schema$CivicinfoApiprotosV2DivisionSearchResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse". + */ + kind?: string | null; + results?: Schema$CivicinfoApiprotosV2DivisionSearchResult[]; + } + /** + * Represents a political geographic division that matches the requested query. + */ + export interface Schema$CivicinfoApiprotosV2DivisionSearchResult { + /** + * Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district. + */ + aliases?: string[] | null; + /** + * The name of the division. + */ + name?: string | null; + /** + * The unique Open Civic Data identifier for this division + */ + ocdId?: string | null; + } + /** + * The list of elections available for this version of the API. + */ + export interface Schema$CivicinfoApiprotosV2ElectionsQueryResponse { + /** + * A list of available elections + */ + elections?: Schema$CivicinfoSchemaV2Election[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse". + */ + kind?: string | null; + } + export interface Schema$CivicinfoApiprotosV2RepresentativeInfoData { + /** + * A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division. + */ + divisions?: { + [key: string]: Schema$CivicinfoSchemaV2GeographicDivision; + } | null; + /** + * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request. + */ + offices?: Schema$CivicinfoSchemaV2Office[]; + /** + * Officials holding the offices listed above. Will only be present if includeOffices was true in the request. + */ + officials?: Schema$CivicinfoSchemaV2Official[]; + } + /** + * The result of a representative info lookup query. + */ + export interface Schema$CivicinfoApiprotosV2RepresentativeInfoResponse { + /** + * A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division. + */ + divisions?: { + [key: string]: Schema$CivicinfoSchemaV2GeographicDivision; + } | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse". + */ + kind?: string | null; + /** + * The normalized version of the requested address + */ + normalizedInput?: Schema$CivicinfoSchemaV2SimpleAddressType; + /** + * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request. + */ + offices?: Schema$CivicinfoSchemaV2Office[]; + /** + * Officials holding the offices listed above. Will only be present if includeOffices was true in the request. + */ + officials?: Schema$CivicinfoSchemaV2Official[]; + } + /** + * The result of a voter info lookup query. + */ + export interface Schema$CivicinfoApiprotosV2VoterInfoResponse { + /** + * Contests that will appear on the voter's ballot. + */ + contests?: Schema$CivicinfoSchemaV2Contest[]; + /** + * Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field. + */ + dropOffLocations?: Schema$CivicinfoSchemaV2PollingLocation[]; + /** + * Locations where the voter is eligible to vote early, prior to election day. + */ + earlyVoteSites?: Schema$CivicinfoSchemaV2PollingLocation[]; + /** + * The election that was queried. + */ + election?: Schema$CivicinfoSchemaV2Election; + /** + * Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse". + */ + kind?: string | null; + /** + * Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well). + */ + mailOnly?: boolean | null; + /** + * The normalized version of the requested address + */ + normalizedInput?: Schema$CivicinfoSchemaV2SimpleAddressType; + /** + * When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user. + */ + otherElections?: Schema$CivicinfoSchemaV2Election[]; + /** + * Locations where the voter is eligible to vote on election day. + */ + pollingLocations?: Schema$CivicinfoSchemaV2PollingLocation[]; + precinctId?: string | null; + /** + * The precincts that match this voter's address. Will only be returned for project IDs which have been allowlisted as "partner projects". + */ + precincts?: Schema$CivicinfoSchemaV2Precinct[]; + /** + * Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array. + */ + state?: Schema$CivicinfoSchemaV2AdministrationRegion[]; + } /** * Describes information about a regional election administrative area. */ - export interface Schema$AdministrationRegion { + export interface Schema$CivicinfoSchemaV2AdministrationRegion { /** * The election administration body for this area. */ - electionAdministrationBody?: Schema$AdministrativeBody; + electionAdministrationBody?: Schema$CivicinfoSchemaV2AdministrativeBody; /** * The city or county that provides election information for this voter. This object can have the same elements as state. */ - local_jurisdiction?: Schema$AdministrationRegion; + local_jurisdiction?: Schema$CivicinfoSchemaV2AdministrationRegion; /** * The name of the jurisdiction. */ @@ -147,12 +289,12 @@ export namespace civicinfo_v2 { /** * A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources. */ - sources?: Schema$Source[]; + sources?: Schema$CivicinfoSchemaV2Source[]; } /** * Information about an election administrative body (e.g. County Board of Elections). */ - export interface Schema$AdministrativeBody { + export interface Schema$CivicinfoSchemaV2AdministrativeBody { /** * A URL provided by this administrative body for information on absentee voting. */ @@ -164,7 +306,7 @@ export namespace civicinfo_v2 { /** * The mailing address of this administrative body. */ - correspondenceAddress?: Schema$SimpleAddressType; + correspondenceAddress?: Schema$CivicinfoSchemaV2SimpleAddressType; /** * A URL provided by this administrative body for looking up general election information. */ @@ -180,7 +322,7 @@ export namespace civicinfo_v2 { /** * The election officials for this election administrative body. */ - electionOfficials?: Schema$ElectionOfficial[]; + electionOfficials?: Schema$CivicinfoSchemaV2ElectionOfficial[]; /** * A URL provided by this administrative body for confirming that the voter is registered to vote. */ @@ -204,7 +346,7 @@ export namespace civicinfo_v2 { /** * The physical address of this administrative body. */ - physicalAddress?: Schema$SimpleAddressType; + physicalAddress?: Schema$CivicinfoSchemaV2SimpleAddressType; /** * A description of the services this administrative body may provide. */ @@ -217,7 +359,7 @@ export namespace civicinfo_v2 { /** * Information about a candidate running for elected office. */ - export interface Schema$Candidate { + export interface Schema$CivicinfoSchemaV2Candidate { /** * The URL for the candidate's campaign web site. */ @@ -225,7 +367,7 @@ export namespace civicinfo_v2 { /** * A list of known (social) media channels for this candidate. */ - channels?: Schema$Channel[]; + channels?: Schema$CivicinfoSchemaV2Channel[]; /** * The email address for the candidate's campaign. */ @@ -254,7 +396,7 @@ export namespace civicinfo_v2 { /** * A social media or web channel for a candidate. */ - export interface Schema$Channel { + export interface Schema$CivicinfoSchemaV2Channel { /** * The unique public identifier for the candidate's channel. */ @@ -267,7 +409,7 @@ export namespace civicinfo_v2 { /** * Information about a contest that appears on a voter's ballot. */ - export interface Schema$Contest { + export interface Schema$CivicinfoSchemaV2Contest { /** * A number specifying the position of this contest on the voter's ballot. */ @@ -279,11 +421,11 @@ export namespace civicinfo_v2 { /** * The candidate choices for this contest. */ - candidates?: Schema$Candidate[]; + candidates?: Schema$CivicinfoSchemaV2Candidate[]; /** * Information about the electoral district that this contest is in. */ - district?: Schema$ElectoralDistrict; + district?: Schema$CivicinfoSchemaV2ElectoralDistrict; /** * A description of any additional eligibility requirements for voting in this contest. */ @@ -355,7 +497,7 @@ export namespace civicinfo_v2 { /** * A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources. */ - sources?: Schema$Source[]; + sources?: Schema$CivicinfoSchemaV2Source[]; /** * "Yes" or "No" depending on whether this a contest being held outside the normal election cycle. */ @@ -365,44 +507,10 @@ export namespace civicinfo_v2 { */ type?: string | null; } - export interface Schema$DivisionByAddressResponse { - divisions?: {[key: string]: Schema$GeographicDivision} | null; - /** - * The normalized version of the requested address. - */ - normalizedInput?: Schema$SimpleAddressType; - } - /** - * The result of a division search query. - */ - export interface Schema$DivisionSearchResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse". - */ - kind?: string | null; - results?: Schema$DivisionSearchResult[]; - } - /** - * Represents a political geographic division that matches the requested query. - */ - export interface Schema$DivisionSearchResult { - /** - * Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district. - */ - aliases?: string[] | null; - /** - * The name of the division. - */ - name?: string | null; - /** - * The unique Open Civic Data identifier for this division - */ - ocdId?: string | null; - } /** * Information about the election that was queried. */ - export interface Schema$Election { + export interface Schema$CivicinfoSchemaV2Election { /** * Day of the election in YYYY-MM-DD format. */ @@ -424,7 +532,7 @@ export namespace civicinfo_v2 { /** * Information about individual election officials. */ - export interface Schema$ElectionOfficial { + export interface Schema$CivicinfoSchemaV2ElectionOfficial { /** * The email address of the election official. */ @@ -446,23 +554,10 @@ export namespace civicinfo_v2 { */ title?: string | null; } - /** - * The list of elections available for this version of the API. - */ - export interface Schema$ElectionsQueryResponse { - /** - * A list of available elections - */ - elections?: Schema$Election[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse". - */ - kind?: string | null; - } /** * Describes the geographic scope of a contest. */ - export interface Schema$ElectoralDistrict { + export interface Schema$CivicinfoSchemaV2ElectoralDistrict { /** * An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper. */ @@ -479,7 +574,7 @@ export namespace civicinfo_v2 { /** * Describes a political geography. */ - export interface Schema$GeographicDivision { + export interface Schema$CivicinfoSchemaV2GeographicDivision { /** * Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc. */ @@ -496,7 +591,7 @@ export namespace civicinfo_v2 { /** * Information about an Office held by one or more Officials. */ - export interface Schema$Office { + export interface Schema$CivicinfoSchemaV2Office { /** * The OCD ID of the division with which this office is associated. */ @@ -520,20 +615,20 @@ export namespace civicinfo_v2 { /** * A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources. */ - sources?: Schema$Source[]; + sources?: Schema$CivicinfoSchemaV2Source[]; } /** * Information about a person holding an elected office. */ - export interface Schema$Official { + export interface Schema$CivicinfoSchemaV2Official { /** * Addresses at which to contact the official. */ - address?: Schema$SimpleAddressType[]; + address?: Schema$CivicinfoSchemaV2SimpleAddressType[]; /** * A list of known (social) media channels for this official. */ - channels?: Schema$Channel[]; + channels?: Schema$CivicinfoSchemaV2Channel[]; /** * The direct email addresses for the official. */ @@ -562,11 +657,11 @@ export namespace civicinfo_v2 { /** * A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot. */ - export interface Schema$PollingLocation { + export interface Schema$CivicinfoSchemaV2PollingLocation { /** * The address of the location. */ - address?: Schema$SimpleAddressType; + address?: Schema$CivicinfoSchemaV2SimpleAddressType; /** * The last date that this early vote site or drop off location may be used. This field is not populated for polling locations. */ @@ -594,7 +689,7 @@ export namespace civicinfo_v2 { /** * A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources. */ - sources?: Schema$Source[]; + sources?: Schema$CivicinfoSchemaV2Source[]; /** * The first date that this early vote site or drop off location may be used. This field is not populated for polling locations. */ @@ -604,7 +699,7 @@ export namespace civicinfo_v2 { */ voterServices?: string | null; } - export interface Schema$Precinct { + export interface Schema$CivicinfoSchemaV2Precinct { /** * ID of the AdministrationRegion message for this precinct. Corresponds to LocalityId xml tag. */ @@ -662,49 +757,10 @@ export namespace civicinfo_v2 { */ ward?: string | null; } - export interface Schema$RepresentativeInfoData { - /** - * A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division. - */ - divisions?: {[key: string]: Schema$GeographicDivision} | null; - /** - * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request. - */ - offices?: Schema$Office[]; - /** - * Officials holding the offices listed above. Will only be present if includeOffices was true in the request. - */ - officials?: Schema$Official[]; - } - /** - * The result of a representative info lookup query. - */ - export interface Schema$RepresentativeInfoResponse { - /** - * A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division. - */ - divisions?: {[key: string]: Schema$GeographicDivision} | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse". - */ - kind?: string | null; - /** - * The normalized version of the requested address - */ - normalizedInput?: Schema$SimpleAddressType; - /** - * Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request. - */ - offices?: Schema$Office[]; - /** - * Officials holding the offices listed above. Will only be present if includeOffices was true in the request. - */ - officials?: Schema$Official[]; - } /** * A simple representation of an address. */ - export interface Schema$SimpleAddressType { + export interface Schema$CivicinfoSchemaV2SimpleAddressType { /** * The city or town for the address. */ @@ -737,7 +793,7 @@ export namespace civicinfo_v2 { /** * Contains information about the data source for the element containing it. */ - export interface Schema$Source { + export interface Schema$CivicinfoSchemaV2Source { /** * The name of the data source. */ @@ -747,56 +803,6 @@ export namespace civicinfo_v2 { */ official?: boolean | null; } - /** - * The result of a voter info lookup query. - */ - export interface Schema$VoterInfoResponse { - /** - * Contests that will appear on the voter's ballot. - */ - contests?: Schema$Contest[]; - /** - * Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field. - */ - dropOffLocations?: Schema$PollingLocation[]; - /** - * Locations where the voter is eligible to vote early, prior to election day. - */ - earlyVoteSites?: Schema$PollingLocation[]; - /** - * The election that was queried. - */ - election?: Schema$Election; - /** - * Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse". - */ - kind?: string | null; - /** - * Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well). - */ - mailOnly?: boolean | null; - /** - * The normalized version of the requested address - */ - normalizedInput?: Schema$SimpleAddressType; - /** - * When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user. - */ - otherElections?: Schema$Election[]; - /** - * Locations where the voter is eligible to vote on election day. - */ - pollingLocations?: Schema$PollingLocation[]; - precinctId?: string | null; - /** - * The precincts that match this voter's address. Will only be returned for project IDs which have been allowlisted as "partner projects". - */ - precincts?: Schema$Precinct[]; - /** - * Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array. - */ - state?: Schema$AdministrationRegion[]; - } export class Resource$Divisions { context: APIRequestContext; @@ -819,7 +825,7 @@ export namespace civicinfo_v2 { queryDivisionByAddress( params?: Params$Resource$Divisions$Querydivisionbyaddress, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; queryDivisionByAddress( params: Params$Resource$Divisions$Querydivisionbyaddress, options: StreamMethodOptions | BodyResponseCallback, @@ -829,32 +835,32 @@ export namespace civicinfo_v2 { params: Params$Resource$Divisions$Querydivisionbyaddress, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; queryDivisionByAddress( params: Params$Resource$Divisions$Querydivisionbyaddress, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; queryDivisionByAddress( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; queryDivisionByAddress( paramsOrCallback?: | Params$Resource$Divisions$Querydivisionbyaddress - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Divisions$Querydivisionbyaddress; @@ -890,12 +896,14 @@ export namespace civicinfo_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -914,7 +922,7 @@ export namespace civicinfo_v2 { search( params?: Params$Resource$Divisions$Search, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; search( params: Params$Resource$Divisions$Search, options: StreamMethodOptions | BodyResponseCallback, @@ -924,30 +932,32 @@ export namespace civicinfo_v2 { params: Params$Resource$Divisions$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; search( params: Params$Resource$Divisions$Search, - callback: BodyResponseCallback + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback ): void; - search(callback: BodyResponseCallback): void; search( paramsOrCallback?: | Params$Resource$Divisions$Search - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Divisions$Search; let options = (optionsOrCallback || {}) as MethodOptions; @@ -982,12 +992,14 @@ export namespace civicinfo_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } @@ -1027,7 +1039,7 @@ export namespace civicinfo_v2 { electionQuery( params?: Params$Resource$Elections$Electionquery, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; electionQuery( params: Params$Resource$Elections$Electionquery, options: StreamMethodOptions | BodyResponseCallback, @@ -1037,32 +1049,32 @@ export namespace civicinfo_v2 { params: Params$Resource$Elections$Electionquery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; electionQuery( params: Params$Resource$Elections$Electionquery, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; electionQuery( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; electionQuery( paramsOrCallback?: | Params$Resource$Elections$Electionquery - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Elections$Electionquery; @@ -1098,12 +1110,14 @@ export namespace civicinfo_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -1122,7 +1136,7 @@ export namespace civicinfo_v2 { voterInfoQuery( params?: Params$Resource$Elections$Voterinfoquery, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; voterInfoQuery( params: Params$Resource$Elections$Voterinfoquery, options: StreamMethodOptions | BodyResponseCallback, @@ -1130,32 +1144,34 @@ export namespace civicinfo_v2 { ): void; voterInfoQuery( params: Params$Resource$Elections$Voterinfoquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; voterInfoQuery( params: Params$Resource$Elections$Voterinfoquery, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; voterInfoQuery( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; voterInfoQuery( paramsOrCallback?: | Params$Resource$Elections$Voterinfoquery - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Elections$Voterinfoquery; @@ -1191,12 +1207,14 @@ export namespace civicinfo_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } @@ -1253,7 +1271,7 @@ export namespace civicinfo_v2 { representativeInfoByAddress( params?: Params$Resource$Representatives$Representativeinfobyaddress, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; representativeInfoByAddress( params: Params$Resource$Representatives$Representativeinfobyaddress, options: StreamMethodOptions | BodyResponseCallback, @@ -1263,32 +1281,32 @@ export namespace civicinfo_v2 { params: Params$Resource$Representatives$Representativeinfobyaddress, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; representativeInfoByAddress( params: Params$Resource$Representatives$Representativeinfobyaddress, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; representativeInfoByAddress( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; representativeInfoByAddress( paramsOrCallback?: | Params$Resource$Representatives$Representativeinfobyaddress - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Representatives$Representativeinfobyaddress; @@ -1325,12 +1343,14 @@ export namespace civicinfo_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -1349,7 +1369,7 @@ export namespace civicinfo_v2 { representativeInfoByDivision( params?: Params$Resource$Representatives$Representativeinfobydivision, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; representativeInfoByDivision( params: Params$Resource$Representatives$Representativeinfobydivision, options: StreamMethodOptions | BodyResponseCallback, @@ -1359,32 +1379,32 @@ export namespace civicinfo_v2 { params: Params$Resource$Representatives$Representativeinfobydivision, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; representativeInfoByDivision( params: Params$Resource$Representatives$Representativeinfobydivision, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; representativeInfoByDivision( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; representativeInfoByDivision( paramsOrCallback?: | Params$Resource$Representatives$Representativeinfobydivision - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Representatives$Representativeinfobydivision; @@ -1421,12 +1441,14 @@ export namespace civicinfo_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 6301b75d5f7..5aaa732b0ae 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -528,6 +528,10 @@ export namespace classroom_v1 { * The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. */ gradeCategory?: Schema$GradeCategory; + /** + * Identifier of the grading period associated with the coursework. * At creation, if unspecified, the grading period ID will be set based on the `dueDate` (or `scheduledTime` if no `dueDate` is set). * To indicate no association to any grading period, set this field to an empty string (""). * If specified, it must match an existing grading period ID in the course. + */ + gradingPeriodId?: string | null; /** * Classroom-assigned identifier of this course work, unique per course. Read-only. */ @@ -846,6 +850,40 @@ export namespace classroom_v1 { */ pointsEarned?: number | null; } + /** + * An individual grading period. Grading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the end_date of a grading period is 2024-01-25, then the start_date of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course. + */ + export interface Schema$GradingPeriod { + /** + * Required. End date, in UTC, of the grading period. Inclusive. + */ + endDate?: Schema$Date; + /** + * Output only. System generated grading period ID. Read-only. + */ + id?: string | null; + /** + * Required. Start date, in UTC, of the grading period. Inclusive. + */ + startDate?: Schema$Date; + /** + * Required. Title of the grading period. For example, “Semester 1”. + */ + title?: string | null; + } + /** + * Grading period settings that include all the individual grading periods in a course. + */ + export interface Schema$GradingPeriodSettings { + /** + * Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update `GradingPeriodSettings`. If not previously set, the default is False. + */ + applyToExistingCoursework?: boolean | null; + /** + * The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course. + */ + gradingPeriods?: Schema$GradingPeriod[]; + } /** * Association between a student and a guardian of that student. The guardian may receive information about the student's course work. */ @@ -1151,7 +1189,7 @@ export namespace classroom_v1 { */ driveFile?: Schema$SharedDriveFile; /** - * Google Forms material. + * Google Forms material. Read-only. */ form?: Schema$Form; /** @@ -1882,6 +1920,100 @@ export namespace classroom_v1 { } } + /** + * Returns the grading period settings in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. * `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`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getGradingPeriodSettings( + params: Params$Resource$Courses$Getgradingperiodsettings, + options: StreamMethodOptions + ): GaxiosPromise; + getGradingPeriodSettings( + params?: Params$Resource$Courses$Getgradingperiodsettings, + options?: MethodOptions + ): GaxiosPromise; + getGradingPeriodSettings( + params: Params$Resource$Courses$Getgradingperiodsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGradingPeriodSettings( + params: Params$Resource$Courses$Getgradingperiodsettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGradingPeriodSettings( + params: Params$Resource$Courses$Getgradingperiodsettings, + callback: BodyResponseCallback + ): void; + getGradingPeriodSettings( + callback: BodyResponseCallback + ): void; + getGradingPeriodSettings( + paramsOrCallback?: + | Params$Resource$Courses$Getgradingperiodsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Courses$Getgradingperiodsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Courses$Getgradingperiodsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://classroom.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/courses/{courseId}/gradingPeriodSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['courseId'], + pathParams: ['courseId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. * @@ -2136,6 +2268,100 @@ export namespace classroom_v1 { return createAPIRequest(parameters); } } + + /** + * Updates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course owner must be eligible to modify Grading Periods. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for access errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the request is malformed. * `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`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateGradingPeriodSettings( + params: Params$Resource$Courses$Updategradingperiodsettings, + options: StreamMethodOptions + ): GaxiosPromise; + updateGradingPeriodSettings( + params?: Params$Resource$Courses$Updategradingperiodsettings, + options?: MethodOptions + ): GaxiosPromise; + updateGradingPeriodSettings( + params: Params$Resource$Courses$Updategradingperiodsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGradingPeriodSettings( + params: Params$Resource$Courses$Updategradingperiodsettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGradingPeriodSettings( + params: Params$Resource$Courses$Updategradingperiodsettings, + callback: BodyResponseCallback + ): void; + updateGradingPeriodSettings( + callback: BodyResponseCallback + ): void; + updateGradingPeriodSettings( + paramsOrCallback?: + | Params$Resource$Courses$Updategradingperiodsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Courses$Updategradingperiodsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Courses$Updategradingperiodsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://classroom.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/courses/{courseId}/gradingPeriodSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['courseId'], + pathParams: ['courseId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Courses$Create extends StandardParameters { @@ -2156,6 +2382,13 @@ export namespace classroom_v1 { */ id?: string; } + export interface Params$Resource$Courses$Getgradingperiodsettings + extends StandardParameters { + /** + * Required. The identifier of the course. + */ + courseId?: string; + } export interface Params$Resource$Courses$List extends StandardParameters { /** * Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. @@ -2204,6 +2437,22 @@ export namespace classroom_v1 { */ requestBody?: Schema$Course; } + export interface Params$Resource$Courses$Updategradingperiodsettings + extends StandardParameters { + /** + * Required. The identifier of the course. + */ + courseId?: string; + /** + * Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GradingPeriodSettings; + } export class Resource$Courses$Aliases { context: APIRequestContext; @@ -2794,7 +3043,7 @@ export namespace classroom_v1 { } /** - * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. + * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3193,7 +3442,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -4124,7 +4373,7 @@ export namespace classroom_v1 { } /** - * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. + * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4480,7 +4729,7 @@ export namespace classroom_v1 { } /** - * Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric. + * Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4609,7 +4858,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -4675,7 +4924,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later. + * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` */ updateMask?: string; @@ -5553,7 +5802,7 @@ export namespace classroom_v1 { } /** - * Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible` + * Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5641,7 +5890,7 @@ export namespace classroom_v1 { } /** - * Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric. + * Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5908,7 +6157,7 @@ export namespace classroom_v1 { } /** - * Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric. + * Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7164,7 +7413,7 @@ export namespace classroom_v1 { } /** - * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. + * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7480,7 +7729,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -8134,7 +8383,7 @@ export namespace classroom_v1 { } /** - * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. + * Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8228,7 +8477,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -9084,7 +9333,7 @@ export namespace classroom_v1 { } /** - * Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course. + * Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9502,7 +9751,7 @@ export namespace classroom_v1 { } /** - * Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course. + * Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index ceb5829820f..197ba2c3911 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -1975,6 +1975,10 @@ export namespace cloudbuild_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudchannel/v1.ts b/src/apis/cloudchannel/v1.ts index 92faab24ea0..7ae56551098 100644 --- a/src/apis/cloudchannel/v1.ts +++ b/src/apis/cloudchannel/v1.ts @@ -295,7 +295,7 @@ export namespace cloudchannel_v1 { */ parameters?: Schema$GoogleCloudChannelV1alpha1Parameter[]; /** - * Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if this field is populated in a request, it isn't evaluated in the API. + * Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. */ priceReferenceId?: string | null; /** @@ -357,6 +357,10 @@ export namespace cloudchannel_v1 { * Resource name of the opportunity. Format: opportunities/{opportunity\} */ opportunity?: string | null; + /** + * Resource name of the partner. Format: partners/{partner\} + */ + partner?: string | null; } /** * Definition for extended entitlement parameters. @@ -681,7 +685,7 @@ export namespace cloudchannel_v1 { */ parameters?: Schema$GoogleCloudChannelV1Parameter[]; /** - * Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if populated in a request, this field isn't evaluated in the API. + * Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. */ priceReferenceId?: string | null; /** @@ -995,6 +999,10 @@ export namespace cloudchannel_v1 { * Output only. Time when the customer was created. */ createTime?: string | null; + /** + * Optional. Indicate if a customer is attesting about the correctness of provided information. Only required if creating a GCP Entitlement. + */ + customerAttestationState?: string | null; /** * Required. The customer's primary domain. Must match the primary contact email's domain. */ @@ -1142,7 +1150,7 @@ export namespace cloudchannel_v1 { */ parameters?: Schema$GoogleCloudChannelV1Parameter[]; /** - * Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if this field is populated in a request, it isn't evaluated in the API. + * Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. */ priceReferenceId?: string | null; /** @@ -1390,7 +1398,7 @@ export namespace cloudchannel_v1 { */ nextPageToken?: string | null; /** - * The list of Offers requested. + * The list of Offers requested. The pricing information for each Offer only includes the base price. Effective prices and discounts aren't populated. */ offers?: Schema$GoogleCloudChannelV1Offer[]; } @@ -1907,7 +1915,7 @@ export namespace cloudchannel_v1 { */ offer?: Schema$GoogleCloudChannelV1Offer; /** - * Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. + * Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. */ priceReferenceId?: string | null; } @@ -2272,7 +2280,7 @@ export namespace cloudchannel_v1 { */ offer?: Schema$GoogleCloudChannelV1Offer; /** - * Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. + * Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. */ priceReferenceId?: string | null; } @@ -2574,15 +2582,15 @@ export namespace cloudchannel_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 + * 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 or 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -2590,7 +2598,7 @@ export namespace cloudchannel_v1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -2598,7 +2606,7 @@ export namespace cloudchannel_v1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -2614,11 +2622,11 @@ export namespace cloudchannel_v1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index 9488d491d7a..5a51f3cadc8 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -581,7 +581,7 @@ export namespace clouddeploy_v1 { */ predeploy?: Schema$Predeploy; /** - * Optional. Whether to run verify tests after each percentage deployment. + * Optional. Whether to run verify tests after each percentage deployment via `skaffold verify`. */ verify?: boolean | null; } @@ -1059,7 +1059,7 @@ export namespace clouddeploy_v1 { */ description?: string | null; /** - * The weak etag of the `Automation` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * The weak etag of the `DeployPolicy` resource. 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; /** @@ -1859,7 +1859,7 @@ export namespace clouddeploy_v1 { */ profiles?: string[] | null; /** - * Optional. Whether to run verify tests after the deployment. + * Optional. Whether to run verify tests after the deployment via `skaffold verify`. */ verify?: boolean | null; } @@ -2902,15 +2902,15 @@ export namespace clouddeploy_v1 { */ export interface Schema$Standard { /** - * Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present. + * Optional. Configuration for the postdeploy job. If this is not configured, the postdeploy job will not be present. */ postdeploy?: Schema$Postdeploy; /** - * Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present. + * Optional. Configuration for the predeploy job. If this is not configured, the predeploy job will not be present. */ predeploy?: Schema$Predeploy; /** - * Optional. Whether to verify a deployment. + * Optional. Whether to verify a deployment via `skaffold verify`. */ verify?: boolean | null; } @@ -3626,6 +3626,10 @@ export namespace clouddeploy_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 8e1ea8627d9..b664c0b6070 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -233,7 +233,7 @@ export namespace cloudfunctions_v1 { */ description?: string | null; /** - * Docker Registry to use for this deployment. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. + * Docker Registry to use for this deployment. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */ dockerRegistry?: string | null; /** @@ -1044,6 +1044,10 @@ export namespace cloudfunctions_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index 1588e9a65b7..ddeba9d1f74 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -185,7 +185,7 @@ export namespace cloudfunctions_v2 { */ build?: string | null; /** - * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. + * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */ dockerRegistry?: string | null; /** @@ -941,7 +941,12 @@ export namespace cloudfunctions_v2 { /** * Request for the `SetupFunctionUpgradeConfig` method. */ - export interface Schema$SetupFunctionUpgradeConfigRequest {} + export interface Schema$SetupFunctionUpgradeConfigRequest { + /** + * Optional. The trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number\}-compute@developer.gserviceaccount.com`. + */ + triggerServiceAccount?: string | null; + } /** * The location of the function source code. */ @@ -1174,6 +1179,10 @@ export namespace cloudfunctions_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index 47aeee8ebe0..7432696bffc 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -185,7 +185,7 @@ export namespace cloudfunctions_v2alpha { */ build?: string | null; /** - * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. + * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */ dockerRegistry?: string | null; /** @@ -941,7 +941,12 @@ export namespace cloudfunctions_v2alpha { /** * Request for the `SetupFunctionUpgradeConfig` method. */ - export interface Schema$SetupFunctionUpgradeConfigRequest {} + export interface Schema$SetupFunctionUpgradeConfigRequest { + /** + * Optional. The trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number\}-compute@developer.gserviceaccount.com`. + */ + triggerServiceAccount?: string | null; + } /** * The location of the function source code. */ @@ -1174,6 +1179,10 @@ export namespace cloudfunctions_v2alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index 6ad01a5e6b5..9adb83bd8cf 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -185,7 +185,7 @@ export namespace cloudfunctions_v2beta { */ build?: string | null; /** - * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. + * Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */ dockerRegistry?: string | null; /** @@ -941,7 +941,12 @@ export namespace cloudfunctions_v2beta { /** * Request for the `SetupFunctionUpgradeConfig` method. */ - export interface Schema$SetupFunctionUpgradeConfigRequest {} + export interface Schema$SetupFunctionUpgradeConfigRequest { + /** + * Optional. The trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number\}-compute@developer.gserviceaccount.com`. + */ + triggerServiceAccount?: string | null; + } /** * The location of the function source code. */ @@ -1174,6 +1179,10 @@ export namespace cloudfunctions_v2beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 8929375b6a7..00dc796eab3 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -2187,6 +2187,10 @@ export namespace cloudkms_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index c25bdc50ab7..f7c8f81a83b 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -302,6 +302,10 @@ export namespace cloudresourcemanager_v2 { * A Folder in an Organization's resource hierarchy, used to organize that Organization's resources. */ export interface Schema$Folder { + /** + * Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`. + */ + configuredCapabilities?: string[] | null; /** * Output only. Timestamp when the Folder was created. Assigned by the server. */ @@ -314,6 +318,10 @@ export namespace cloudresourcemanager_v2 { * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ lifecycleState?: string | null; + /** + * Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY. + */ + managementProject?: string | null; /** * Output only. The resource name of the Folder. Its format is `folders/{folder_id\}`, for example: "folders/1234". */ diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 97e3ef23116..6cafb576c72 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -302,6 +302,10 @@ export namespace cloudresourcemanager_v2beta1 { * A Folder in an Organization's resource hierarchy, used to organize that Organization's resources. */ export interface Schema$Folder { + /** + * Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`. + */ + configuredCapabilities?: string[] | null; /** * Output only. Timestamp when the Folder was created. Assigned by the server. */ @@ -314,6 +318,10 @@ export namespace cloudresourcemanager_v2beta1 { * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ lifecycleState?: string | null; + /** + * Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY. + */ + managementProject?: string | null; /** * Output only. The resource name of the Folder. Its format is `folders/{folder_id\}`, for example: "folders/1234". */ diff --git a/src/apis/cloudresourcemanager/v3.ts b/src/apis/cloudresourcemanager/v3.ts index 6798f6b9f4d..6c94d4854d7 100644 --- a/src/apis/cloudresourcemanager/v3.ts +++ b/src/apis/cloudresourcemanager/v3.ts @@ -183,6 +183,19 @@ export namespace cloudresourcemanager_v3 { */ role?: string | null; } + /** + * Representation of a Capability. + */ + export interface Schema$Capability { + /** + * Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id\}/capabilities/{capability_name\}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name\} values: * `app-management` + */ + name?: string | null; + /** + * Required. The configured value of the capability at the given parent resource. + */ + value?: boolean | null; + } /** * Metadata describing a long running folder operation */ @@ -349,6 +362,10 @@ export namespace cloudresourcemanager_v3 { * A folder in an organization's resource hierarchy, used to organize that organization's resources. */ export interface Schema$Folder { + /** + * Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`. + */ + configuredCapabilities?: string[] | null; /** * Output only. Timestamp when the folder was created. */ @@ -365,6 +382,10 @@ export namespace cloudresourcemanager_v3 { * Output only. A checksum computed by the server based on the current value of the folder resource. This 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. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY. + */ + managementProject?: string | null; /** * Output only. The resource name of the folder. Its format is `folders/{folder_id\}`, for example: "folders/1234". */ @@ -1125,8 +1146,10 @@ export namespace cloudresourcemanager_v3 { export class Resource$Folders { context: APIRequestContext; + capabilities: Resource$Folders$Capabilities; constructor(context: APIRequestContext) { this.context = context; + this.capabilities = new Resource$Folders$Capabilities(this.context); } /** @@ -2219,6 +2242,209 @@ export namespace cloudresourcemanager_v3 { requestBody?: Schema$UndeleteFolderRequest; } + export class Resource$Folders$Capabilities { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the Capability identified by the supplied 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$Folders$Capabilities$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Folders$Capabilities$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Folders$Capabilities$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Folders$Capabilities$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Folders$Capabilities$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Folders$Capabilities$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Capabilities$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Capabilities$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudresourcemanager.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); + } + } + + /** + * Updates the Capability. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Folders$Capabilities$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Folders$Capabilities$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Folders$Capabilities$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Folders$Capabilities$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Folders$Capabilities$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Folders$Capabilities$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Capabilities$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Capabilities$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudresourcemanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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$Folders$Capabilities$Get + extends StandardParameters { + /** + * Required. The name of the capability to get. For example, `folders/123/capabilities/app-management` + */ + name?: string; + } + export interface Params$Resource$Folders$Capabilities$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id\}/capabilities/{capability_name\}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name\} values: * `app-management` + */ + name?: string; + /** + * Optional. The list of fields to update. Only [Capability.value] can be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Capability; + } + export class Resource$Liens { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index e8ecd3f7836..c648968c2d8 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -1120,6 +1120,10 @@ export namespace cloudscheduler_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index 564366eacff..8a24f44b09f 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -687,6 +687,10 @@ export namespace cloudscheduler_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 0fc2160bce4..27e5f1e0999 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -1127,6 +1127,10 @@ export namespace cloudtasks_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 8f3e0a97707..a4b3700c75a 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -1377,6 +1377,10 @@ export namespace cloudtasks_v2beta2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index ca7938223f3..dad543916a0 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -1194,6 +1194,10 @@ export namespace cloudtasks_v2beta3 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index 1573db82c2d..783b341b8ba 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -210,7 +210,7 @@ export namespace cloudtrace_v1 { } /** - * Sends new traces to Cloud Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created. + * Sends trace spans to Cloud Trace. Spans cannot be updated. If the trace ID and span ID already exist, an additional copy of the span will be stored. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 1c0eaf27bb7..4534b547eb1 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -451,7 +451,7 @@ export namespace cloudtrace_v2 { } /** - * Batch writes new spans to new or existing traces. You cannot update existing spans. + * Batch writes new spans to new or existing traces. You cannot update existing spans. If a span ID already exists, an additional copy of the span will be stored. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -559,7 +559,7 @@ export namespace cloudtrace_v2 { } /** - * Creates a new span. + * Creates a new span. If a span ID already exists, an additional copy of the span will be stored. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 2abb66b9dfa..eba6e57f3f9 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -171,6 +171,7 @@ export namespace compute_alpha { nodeTypes: Resource$Nodetypes; organizationSecurityPolicies: Resource$Organizationsecuritypolicies; packetMirrorings: Resource$Packetmirrorings; + previewFeatures: Resource$Previewfeatures; projects: Resource$Projects; publicAdvertisedPrefixes: Resource$Publicadvertisedprefixes; publicDelegatedPrefixes: Resource$Publicdelegatedprefixes; @@ -209,13 +210,16 @@ export namespace compute_alpha { regionTargetTcpProxies: Resource$Regiontargettcpproxies; regionUrlMaps: Resource$Regionurlmaps; regionZones: Resource$Regionzones; + reliabilityRisks: Resource$Reliabilityrisks; reservationBlocks: Resource$Reservationblocks; reservations: Resource$Reservations; + reservationSubBlocks: Resource$Reservationsubblocks; resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; routes: Resource$Routes; securityPolicies: Resource$Securitypolicies; serviceAttachments: Resource$Serviceattachments; + snapshotGroups: Resource$Snapshotgroups; snapshots: Resource$Snapshots; snapshotSettings: Resource$Snapshotsettings; sslCertificates: Resource$Sslcertificates; @@ -322,6 +326,7 @@ export namespace compute_alpha { this.organizationSecurityPolicies = new Resource$Organizationsecuritypolicies(this.context); this.packetMirrorings = new Resource$Packetmirrorings(this.context); + this.previewFeatures = new Resource$Previewfeatures(this.context); this.projects = new Resource$Projects(this.context); this.publicAdvertisedPrefixes = new Resource$Publicadvertisedprefixes( this.context @@ -396,13 +401,18 @@ export namespace compute_alpha { ); this.regionUrlMaps = new Resource$Regionurlmaps(this.context); this.regionZones = new Resource$Regionzones(this.context); + this.reliabilityRisks = new Resource$Reliabilityrisks(this.context); this.reservationBlocks = new Resource$Reservationblocks(this.context); this.reservations = new Resource$Reservations(this.context); + this.reservationSubBlocks = new Resource$Reservationsubblocks( + this.context + ); this.resourcePolicies = new Resource$Resourcepolicies(this.context); this.routers = new Resource$Routers(this.context); this.routes = new Resource$Routes(this.context); this.securityPolicies = new Resource$Securitypolicies(this.context); this.serviceAttachments = new Resource$Serviceattachments(this.context); + this.snapshotGroups = new Resource$Snapshotgroups(this.context); this.snapshots = new Resource$Snapshots(this.context); this.snapshotSettings = new Resource$Snapshotsettings(this.context); this.sslCertificates = new Resource$Sslcertificates(this.context); @@ -1587,7 +1597,7 @@ export namespace compute_alpha { */ failover?: boolean | null; /** - * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. + * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP. */ group?: string | null; /** @@ -1709,7 +1719,7 @@ export namespace compute_alpha { */ clientTtl?: number | null; /** - * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. + * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. */ defaultTtl?: number | null; /** @@ -1729,7 +1739,7 @@ export namespace compute_alpha { */ requestCoalescing?: boolean | null; /** - * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. + * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. */ serveWhileStale?: number | null; /** @@ -1883,13 +1893,16 @@ export namespace compute_alpha { * Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. */ compressionMode?: string | null; + /** + * connectionDraining cannot be specified with haPolicy. + */ connectionDraining?: Schema$ConnectionDraining; /** - * Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. + * Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy. */ connectionTrackingPolicy?: Schema$BackendServiceConnectionTrackingPolicy; /** - * Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ consistentHash?: Schema$ConsistentHashLoadBalancerSettings; /** @@ -1933,7 +1946,7 @@ export namespace compute_alpha { */ externalManagedMigrationTestingPercentage?: number | null; /** - * Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). + * Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy. */ failoverPolicy?: Schema$BackendServiceFailoverPolicy; /** @@ -1941,11 +1954,11 @@ export namespace compute_alpha { */ fingerprint?: string | null; /** - * Configuring haPolicy is not supported. + * Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers. */ haPolicy?: Schema$BackendServiceHAPolicy; /** - * The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. + * The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy. */ healthChecks?: string[] | null; /** @@ -1973,7 +1986,7 @@ export namespace compute_alpha { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy. */ localityLbPolicy?: string | null; /** @@ -1993,15 +2006,15 @@ export namespace compute_alpha { */ name?: string | null; /** - * 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. + * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. 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. + * Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy. */ 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. + * 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, HTTP2 or H2C, 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. */ outlierDetection?: Schema$OutlierDetection; /** @@ -2013,7 +2026,7 @@ export namespace compute_alpha { */ portName?: string | null; /** - * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. */ protocol?: string | null; /** @@ -2045,13 +2058,16 @@ export namespace compute_alpha { */ serviceLbPolicy?: string | null; /** - * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy. */ sessionAffinity?: string | null; /** * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. */ strongSessionAffinityCookie?: Schema$BackendServiceHttpCookie; + /** + * subsetting cannot be specified with haPolicy. + */ subsetting?: Schema$Subsetting; /** * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. @@ -2128,7 +2144,7 @@ export namespace compute_alpha { */ clientTtl?: number | null; /** - * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. + * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. */ defaultTtl?: number | null; /** @@ -2148,7 +2164,7 @@ export namespace compute_alpha { */ requestCoalescing?: boolean | null; /** - * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. + * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. */ serveWhileStale?: number | null; /** @@ -2267,27 +2283,27 @@ export namespace compute_alpha { } export interface Schema$BackendServiceHAPolicy { /** - * Enabling fastIPMove is not supported. + * Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to update the leader. - \>GARP_RA: Provides a method to very quickly define a new network endpoint as the leader. This method is faster than updating the leader using the haPolicy.leader API. Fast IP move works as follows: The VM hosting the network endpoint that should become the new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays active for approximately 20 minutes. After triggering fast failover, you must also appropriately set the haPolicy.leader. - The new leader instance should continue to send GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from different VM instances at the same time. If multiple instances continue to send GARP/RA packets, traffic might be routed to different destinations in an alternating order. This condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always takes priority over the leader API. Using the haPolicy.leader API to change the leader to a different instance will have no effect until the GARP/RA request becomes inactive. - The GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding rules refer to a regional backend service, you need only send a GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend service will also be moved to the sender of the GARP or RA packet. The following are the Fast IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED. */ fastIPMove?: string | null; /** - * Setting a leader is not supported. + * Selects one of the network endpoints attached to the backend NEGs of this service as the active endpoint (the leader) that receives all traffic. When the leader changes, there is no connection draining to persist existing connections on the old leader. You are responsible for selecting a suitable endpoint as the leader. For example, preferring a healthy endpoint over unhealthy ones. Note that this service does not track backend endpoint health, and selects the configured leader unconditionally. */ leader?: Schema$BackendServiceHAPolicyLeader; } export interface Schema$BackendServiceHAPolicyLeader { /** - * Setting backendGroup is not supported. + * A fully-qualified URL (starting with https://www.googleapis.com/) of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints that the leader is attached to. The leader's backendGroup must already be specified as a backend of this backend service. Removing a backend that is designated as the leader's backendGroup is not permitted. */ backendGroup?: string | null; /** - * Setting a network endpoint as leader is not supported. + * The network endpoint within the leader.backendGroup that is designated as the leader. This network endpoint cannot be detached from the NEG specified in the haPolicy.leader.backendGroup until the leader is updated with another network endpoint, or the leader is removed from the haPolicy. */ networkEndpoint?: Schema$BackendServiceHAPolicyLeaderNetworkEndpoint; } export interface Schema$BackendServiceHAPolicyLeaderNetworkEndpoint { /** - * Specifying the instance name of a leader is not supported. + * The name of the VM instance of the leader network endpoint. The instance must already be attached to the NEG specified in the haPolicy.leader.backendGroup. The name must be 1-63 characters long, and comply with RFC1035. Authorization requires the following IAM permission on the specified resource instance: compute.instances.use */ instance?: string | null; } @@ -2750,6 +2766,14 @@ export namespace compute_alpha { * A transient resource used in compute.disks.bulkInsert and compute.regionDisks.bulkInsert. It is only used to process requests and is not persisted. */ export interface Schema$BulkInsertDiskResource { + /** + * The parameters for the instant snapshot group. + */ + instantSnapshotGroupParameters?: Schema$InstantSnapshotGroupParameters; + /** + * The parameters for the snapshot group. + */ + snapshotGroupParameters?: Schema$SnapshotGroupParameters; /** * The URL of the DiskConsistencyGroupPolicy for the group of disks to clone. This may be a full or partial URL, such as: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy */ @@ -2850,7 +2874,7 @@ export namespace compute_alpha { } 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. + * 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; /** @@ -3584,6 +3608,23 @@ export namespace compute_alpha { */ path?: 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; + } /** * Deprecation status for a public resource. */ @@ -4519,6 +4560,10 @@ export namespace compute_alpha { * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$FirewallParams; /** * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ @@ -4598,6 +4643,15 @@ export namespace compute_alpha { */ metadata?: string | null; } + /** + * Additional firewall parameters. + */ + export interface Schema$FirewallParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$FirewallPoliciesListAssociationsResponse { /** * A list of associations. @@ -4666,6 +4720,10 @@ export namespace compute_alpha { * [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. */ parent?: string | null; + /** + * The type of the firewall policy. This field can be either VPC_POLICY or RDMA_ROCE_POLICY. Note: if not specified then VPC_POLICY will be used. + */ + policyType?: string | null; /** * [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ @@ -4795,6 +4853,10 @@ export namespace compute_alpha { * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. */ securityProfileGroup?: string | null; + /** + * A list of forwarding rules to which this rule applies. This field allows you to control which load balancers get this rule. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/forwardingRules/forwardingRule - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - projects/project/global/ forwardingRules/forwardingRule - projects/project/regions/region/forwardingRules/ forwardingRule + */ + targetForwardingRules?: string[] | null; /** * A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. */ @@ -4807,6 +4869,10 @@ export namespace compute_alpha { * A list of service accounts indicating the sets of instances that are applied with this rule. */ targetServiceAccounts?: string[] | null; + /** + * Target types of the firewall policy rule. Default value is INSTANCES. + */ + targetType?: string | null; /** * Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. */ @@ -4832,6 +4898,10 @@ export namespace compute_alpha { * Network scope of the traffic destination. */ destNetworkScope?: string | null; + /** + * Network type of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET + */ + destNetworkType?: string | null; /** * Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. */ @@ -4864,6 +4934,10 @@ export namespace compute_alpha { * Network scope of the traffic source. */ srcNetworkScope?: string | null; + /** + * Network type of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS + */ + srcNetworkType?: string | null; /** * Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. */ @@ -5217,6 +5291,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the future reservation. */ description?: string | null; + /** + * Indicates if this group of VMs have emergent maintenance enabled. + */ + enableEmergentMaintenance?: boolean | null; /** * [Output Only] A unique identifier for this future reservation. The server defines this identifier. */ @@ -5717,6 +5795,14 @@ export namespace compute_alpha { * The type of maintenance for the reservation. */ schedulingType?: string | null; + /** + * Describes number of subblock Infrastructure that has ongoing maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family(e.g. NVLink Domains). Not all VM Families will support this field. + */ + subblockInfraMaintenanceOngoingCount?: number | null; + /** + * Describes number of subblock Infrastructure that has pending maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family (e.g. NVLink Domains). Not all VM Families will support this field. + */ + subblockInfraMaintenancePendingCount?: number | null; /** * Maintenance information on this group of VMs. */ @@ -5828,7 +5914,7 @@ export namespace compute_alpha { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. + * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features. */ type?: string | null; } @@ -8129,7 +8215,7 @@ export namespace compute_alpha { */ id?: string | null; /** - * The list of specifications of per-instance configs to be created. This field cannot be used together with 'resize_by'. + * The names of instances to be created by this resize request. The number of names specified determines the number of instances to create. The group's target size will be increased by this number. This field cannot be used together with 'resize_by'. */ instances?: Schema$PerInstanceConfig[]; /** @@ -9066,7 +9152,7 @@ export namespace compute_alpha { */ actionHint?: string | null; /** - * The disruption schedule for the VM. Default to IMMEDIATE. + * The disruption schedule for the VM. Required field, only allows IMMEDIATE. */ disruptionSchedule?: string | null; faultReasons?: Schema$InstancesReportHostAsFaultyRequestFaultReason[]; @@ -9481,6 +9567,12 @@ export namespace compute_alpha { */ zone?: string | null; } + export interface Schema$InstantSnapshotGroupParameters { + /** + * The source instant snapshot group used to create disks. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshotGroups/instantSnapshotGroup - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup - zones/zone/instantSnapshotGroups/instantSnapshotGroup + */ + sourceInstantSnapshotGroup?: string | null; + } export interface Schema$InstantSnapshotGroupResourceStatus { /** * [Output Only] @@ -9638,7 +9730,7 @@ export namespace compute_alpha { */ labels?: {[key: string]: 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. + * 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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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; /** @@ -10230,7 +10322,7 @@ export namespace compute_alpha { */ 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 of the resource. Provided by the client when the resource is created. Must be set on either the template_attachment or on each specific attachment. If set, 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; /** @@ -10783,11 +10875,11 @@ export namespace compute_alpha { */ 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. + * 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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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 of the Interconnects to be created. This must be specified on the template and/or on each individual interconnect. The name, if not empty, must be 1-63 characters long, and comply with RFC1035. Specifically, any nonempty 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; /** @@ -10942,7 +11034,7 @@ export namespace compute_alpha { */ availableFeatures?: string[] | null; /** - * [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR + * [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 */ availableLinkTypes?: string[] | null; /** @@ -11064,6 +11156,10 @@ export namespace compute_alpha { * Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. */ expectedRttMs?: string | null; + /** + * Identifies whether L2 Interconnect Attachments can be created in this region for interconnects that are in this location. + */ + l2ForwardingEnabled?: boolean | null; /** * Identifies the network presence of this location. */ @@ -11418,6 +11514,10 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for this resource. */ selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; /** * [Output Only] Informational warning message. */ @@ -11736,6 +11836,44 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Contains a list of SnapshotGroup resources. + */ + export interface Schema$ListSnapshotGroups { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SnapshotGroup resources. + */ + items?: Schema$SnapshotGroup[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$LocalDisk { /** * Specifies the number of such disks. @@ -11827,6 +11965,14 @@ export namespace compute_alpha { * [Output Only] The resource type, which is always compute#machineImage for machine image. */ kind?: string | null; + /** + * A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this machine image. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; /** * Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later. */ @@ -12144,6 +12290,10 @@ export namespace compute_alpha { * [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. */ propertiesFromFlexibilityPolicy?: Schema$ManagedInstancePropertiesFromFlexibilityPolicy; + /** + * [Output Only] Information about the termination timestamp of the instance, if applicable. + */ + scheduling?: Schema$ManagedInstanceScheduling; /** * [Output only] The size of the VM represented by this Managed Instance. This is how much this Managed Instance contributes to the size of the group. */ @@ -12226,6 +12376,12 @@ export namespace compute_alpha { */ provisioningModel?: string | null; } + export interface Schema$ManagedInstanceScheduling { + /** + * [Output Only] The timestamp at which the managed instance will be terminated. This is in RFC3339 text format. + */ + terminationTimestamp?: string | null; + } export interface Schema$ManagedInstanceVersion { /** * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING \}. @@ -12474,6 +12630,10 @@ export namespace compute_alpha { } export interface Schema$MultiMigStatus { memberInstanceGroupManagers?: string[] | null; + /** + * [Output Only] The number of instance group manager members in this multi-MIG. + */ + membersCount?: number | null; } /** * [Deprecated] Configuration for the mutual Tls mode for peer authentication. Configuration for the mutual Tls mode for peer authentication. @@ -12611,6 +12771,10 @@ export namespace compute_alpha { * A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version\}/projects/{project_id\}/global/networkProfiles/{network_profile_name\} - projects/{project_id\}/global/networkProfiles/{network_profile_name\} */ networkProfile?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$NetworkParams; /** * [Output Only] A list of network peerings for the resource. */ @@ -13444,6 +13608,15 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Additional network parameters. + */ + export interface Schema$NetworkParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. */ @@ -13456,6 +13629,10 @@ export namespace compute_alpha { * This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ autoCreateRoutes?: boolean | null; + /** + * [Output Only] The effective state of the peering connection as a whole. + */ + connectionStatus?: Schema$NetworkPeeringConnectionStatus; /** * Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ @@ -13485,7 +13662,7 @@ export namespace compute_alpha { */ network?: string | null; /** - * Maximum Transmission Unit in bytes. + * [Output Only] Maximum Transmission Unit in bytes of the peer network. */ peerMtu?: number | null; /** @@ -13500,6 +13677,62 @@ export namespace compute_alpha { * [Output Only] Details about the current state of the peering. */ stateDetails?: string | null; + /** + * The update strategy determines the semantics for updates and deletes to the peering connection configuration. + */ + updateStrategy?: string | null; + } + /** + * [Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings. + */ + export interface Schema$NetworkPeeringConnectionStatus { + /** + * The consensus state contains information about the status of update and delete for a consensus peering connection. + */ + consensusState?: Schema$NetworkPeeringConnectionStatusConsensusState; + /** + * The active connectivity settings for the peering connection based on the settings of the network peerings. + */ + trafficConfiguration?: Schema$NetworkPeeringConnectionStatusTrafficConfiguration; + /** + * The update strategy determines the update/delete semantics for this peering connection. + */ + updateStrategy?: string | null; + } + /** + * The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS. + */ + export interface Schema$NetworkPeeringConnectionStatusConsensusState { + /** + * The status of the delete request. + */ + deleteStatus?: string | null; + /** + * The status of the update request. + */ + updateStatus?: string | null; + } + export interface Schema$NetworkPeeringConnectionStatusTrafficConfiguration { + /** + * Whether custom routes are being exported to the peer network. + */ + exportCustomRoutesToPeer?: boolean | null; + /** + * Whether subnet routes with public IP ranges are being exported to the peer network. + */ + exportSubnetRoutesWithPublicIpToPeer?: boolean | null; + /** + * Whether custom routes are being imported from the peer network. + */ + importCustomRoutesFromPeer?: boolean | null; + /** + * Whether subnet routes with public IP ranges are being imported from the peer network. + */ + importSubnetRoutesWithPublicIpFromPeer?: boolean | null; + /** + * Which IP version(s) of traffic and routes are being imported or exported between peer networks. + */ + stackType?: string | null; } export interface Schema$NetworkPerformanceConfig { externalIpEgressBandwidthTier?: string | null; @@ -13575,6 +13808,10 @@ export namespace compute_alpha { * Specifies whether cloud router creation is allowed. */ allowCloudRouter?: string | null; + /** + * Specifies whether default NIC attachment is allowed. + */ + allowDefaultNicAttachment?: string | null; /** * Specifies whether VMs are allowed to have external IP access on network interfaces connected to this VPC. */ @@ -13583,6 +13820,10 @@ export namespace compute_alpha { * Specifies whether Cloud Interconnect creation is allowed. */ allowInterconnect?: string | null; + /** + * Specifies whether IP forwarding is allowed. + */ + allowIpForwarding?: string | null; /** * Specifies whether cloud load balancing is allowed. */ @@ -13591,6 +13832,14 @@ export namespace compute_alpha { * Specifies whether multi-nic in the same network is allowed. */ allowMultiNicInSameNetwork?: string | null; + /** + * Specifies whether NCC is allowed. + */ + allowNcc?: string | null; + /** + * Specifies whether VM network migration is allowed. + */ + allowNetworkMigration?: string | null; /** * Specifies whether Packet Mirroring 1.0 is supported. */ @@ -13635,6 +13884,14 @@ export namespace compute_alpha { * Specifies which subnetwork stack types are supported. */ subnetStackTypes?: string[] | null; + /** + * Specifies which subnetwork purposes are supported. + */ + subnetworkPurposes?: string[] | null; + /** + * Specifies which subnetwork stack types are supported. + */ + subnetworkStackTypes?: string[] | null; /** * Specifies which type of unicast is supported. */ @@ -13796,6 +14053,12 @@ export namespace compute_alpha { */ name?: string | null; } + export interface Schema$NetworksRequestRemovePeeringRequest { + /** + * Name of the peering, which should conform to RFC1035. + */ + name?: string | null; + } export interface Schema$NetworksUpdatePeeringRequest { networkPeering?: Schema$NetworkPeering; } @@ -15296,6 +15559,147 @@ export namespace compute_alpha { */ literal?: string | null; } + /** + * Represents a single Google Compute Engine preview feature. + */ + export interface Schema$PreviewFeature { + /** + * Specifies whether the feature is enabled or disabled. + */ + activationStatus?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] Description of the feature. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] The type of the feature. Always "compute#previewFeature" for preview features. + */ + kind?: string | null; + /** + * Name of the feature. + */ + name?: string | null; + /** + * Rollout operation of the feature. + */ + rolloutOperation?: Schema$PreviewFeatureRolloutOperation; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output only] Status of the feature. + */ + status?: Schema$PreviewFeatureStatus; + } + export interface Schema$PreviewFeatureList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PreviewFeature resources. + */ + items?: Schema$PreviewFeature[]; + /** + * [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 the rollout operation + */ + export interface Schema$PreviewFeatureRolloutOperation { + rolloutInput?: Schema$PreviewFeatureRolloutOperationRolloutInput; + rolloutStatus?: Schema$PreviewFeatureRolloutOperationRolloutStatus; + } + export interface Schema$PreviewFeatureRolloutOperationRolloutInput { + /** + * The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/. + */ + name?: string | null; + /** + * Predefined rollout plan. + */ + predefinedRolloutPlan?: string | null; + /** + * The UUID of the retry action. Only needed if this is a retry for an existing rollout. This can be used after the user canceled a rollout and want to retry it with no changes. + */ + retryUuid?: string | null; + } + export interface Schema$PreviewFeatureRolloutOperationRolloutStatus { + /** + * Output only. The ongoing rollout resources. There can be multiple ongoing rollouts for a resource. + */ + ongoingRollouts?: Schema$PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata[]; + /** + * Output only. The last completed rollout resource. This field will not be populated until the first rollout is completed. + */ + previousRollout?: Schema$PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata; + } + export interface Schema$PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata { + /** + * The name of the rollout Ex. organizations//locations/global/rollouts/ Ex. folders//locations/global/rollouts/ Ex. projects//locations/global/rollouts/. + */ + rollout?: string | null; + /** + * The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/. + */ + rolloutPlan?: string | null; + /** + * The status of the rollout. + */ + status?: Schema$PreviewFeatureStatus; + } + /** + * [Output Only] The status of the feature. + */ + export interface Schema$PreviewFeatureStatus { + /** + * [Output Only] The description of the feature. + */ + description?: string | null; + /** + * [Output Only] Link to the public documentation for the feature. + */ + helpLink?: string | null; + releaseStatus?: Schema$PreviewFeatureStatusReleaseStatus; + } + export interface Schema$PreviewFeatureStatusReleaseStatus { + /** + * [Output Only] The stage of the feature. + */ + stage?: string | null; + /** + * Output only. The last date when a feature transitioned between ReleaseStatuses. + */ + updateDate?: Schema$Date; + } /** * [Deprecated] All fields defined in a principal are ANDed. */ @@ -15659,7 +16063,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string | null; /** - * [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. + * [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is announced and ready to use. - `DELETING` The public delegated prefix is being deprovsioned. */ status?: string | null; } @@ -16652,6 +17056,78 @@ export namespace compute_alpha { export interface Schema$RegionWaitForReplicationCatchUpRequest { maxWaitDuration?: string | null; } + /** + * Represents a ReliabilityRisk resource. + */ + export interface Schema$ReliabilityRisk { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional textual description of the resource; provided when the resource is created. + */ + description?: string | null; + /** + * [Output Only] Details of the reliability risk resource + */ + details?: Schema$RiskDetails; + /** + * [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#reliabilityRisk for reliability risks. + */ + kind?: string | null; + /** + * Name of the resource. The name must be 1-63 characters long and comply with RFC1035. + */ + name?: string | null; + /** + * The recommendations to mitigate the risk. + */ + recommendation?: Schema$RiskRecommendation; + /** + * [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; + } + export interface Schema$ReliabilityRisksListResponse { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of ReliabilityRisk resources. + */ + items?: Schema$ReliabilityRisk[]; + /** + * [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$ReplicationDetails { /** * The last sync time of the device pair. @@ -16717,6 +17193,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * Indicates if this group of VMs have emergent maintenance enabled. + */ + enableEmergentMaintenance?: boolean | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ @@ -16725,6 +17205,10 @@ export namespace compute_alpha { * [Output Only] Type of the resource. Always compute#reservations for reservations. */ kind?: string | null; + /** + * [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments. + */ + linkedCommitments?: string[] | null; /** * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -16749,6 +17233,10 @@ export namespace compute_alpha { * [Output Only] Reserved for future use. */ satisfiesPzs?: boolean | null; + /** + * The type of maintenance for the reservation. + */ + schedulingType?: string | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ @@ -16872,6 +17360,14 @@ export namespace compute_alpha { * [Output Only] Maintenance information for this reservation block. */ reservationMaintenance?: Schema$GroupMaintenanceInfo; + /** + * [Output Only] The number of reservation subBlocks associated with this reservation block. + */ + reservationSubBlockCount?: number | null; + /** + * [Output Only] The number of in-use reservation subBlocks associated with this reservation block. If at least one VM is running on a subBlock, it is considered in-use. + */ + reservationSubBlockInUseCount?: number | null; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ @@ -16997,6 +17493,109 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Represents a reservation subBlock resource. + */ + export interface Schema$ReservationSubBlock { + /** + * [Output Only] The number of hosts that are allocated in this reservation subBlock. + */ + count?: number | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] The number of instances that are currently in use on this reservation subBlock. + */ + inUseCount?: number | null; + /** + * [Output Only] Type of the resource. Always compute#reservationSubBlock for reservation subBlocks. + */ + kind?: string | null; + /** + * [Output Only] The name of this reservation subBlock generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61\}[a-z0-9])? + */ + name?: string | null; + /** + * [Output Only] The physical topology of the reservation subBlock. + */ + physicalTopology?: Schema$ReservationSubBlockPhysicalTopology; + /** + * Maintenance information for this reservation subBlock. + */ + reservationSubBlockMaintenance?: Schema$GroupMaintenanceInfo; + /** + * [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] Status of the reservation subBlock. + */ + status?: string | null; + /** + * [Output Only] Zone in which the reservation subBlock resides. + */ + zone?: string | null; + } + export interface Schema$ReservationSubBlockPhysicalTopology { + /** + * The hash of the capacity block within the cluster. + */ + block?: string | null; + /** + * The cluster name of the reservation subBlock. + */ + cluster?: string | null; + /** + * The hash of the capacity sub-block within the capacity block. + */ + subBlock?: string | null; + } + export interface Schema$ReservationSubBlocksGetResponse { + resource?: Schema$ReservationSubBlock; + } + /** + * A list of reservation subBlocks under a single reservation. + */ + export interface Schema$ReservationSubBlocksListResponse { + /** + * Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of reservation subBlock resources. + */ + items?: Schema$ReservationSubBlock[]; + /** + * Type of the resource. Always compute#reservationSubBlock for a list of reservation subBlocks. + */ + 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; + /** + * Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Commitment for a particular hardware resource (a commitment is composed of one or more of these). */ @@ -17484,10 +18083,30 @@ export namespace compute_alpha { * Effective values of predefined metadata keys for an instance. */ export interface Schema$ResourceStatusEffectiveInstanceMetadata { + /** + * Effective block-project-ssh-keys value at Instance level. + */ + blockProjectSshKeysMetadataValue?: boolean | null; + /** + * Effective enable-guest-attributes value at Instance level. + */ + enableGuestAttributesMetadataValue?: boolean | null; + /** + * Effective enable-osconfig value at Instance level. + */ + enableOsconfigMetadataValue?: boolean | null; + /** + * Effective enable-osinventory value at Instance level. + */ + enableOsInventoryMetadataValue?: boolean | null; /** * Effective enable-oslogin value at Instance level. */ enableOsloginMetadataValue?: boolean | null; + /** + * Effective serial-port-enable value at Instance level. + */ + serialPortEnableMetadataValue?: boolean | null; /** * Effective VM DNS setting at Instance level. */ @@ -17570,6 +18189,59 @@ export namespace compute_alpha { */ targetState?: string | null; } + /** + * Details about a risk. + */ + export interface Schema$RiskDetails { + /** + * The duration of the risk since it was detected. + */ + duration?: string | null; + globalDnsInsight?: Schema$RiskDetailsGlobalDnsInsight; + /** + * The last time the risk was updated. + */ + lastUpdateTimestamp?: string | null; + /** + * The severity of the risk. + */ + severity?: string | null; + /** + * The type of risk. + */ + type?: string | null; + } + export interface Schema$RiskDetailsGlobalDnsInsight { + /** + * Whether the project default DNS setting is global or not. + */ + projectDefaultIsGlobalDns?: boolean | null; + /** + * The observation window for the query counts. + */ + queryObservationWindow?: string | null; + /** + * The number of queries that are risky. This will always be less than total_query_count. + */ + riskyQueryCount?: string | null; + /** + * The total number of queries in the observation window. + */ + totalQueryCount?: string | null; + } + /** + * Recommendation with reference url. + */ + export interface Schema$RiskRecommendation { + /** + * Mitigation guide for the risk. + */ + content?: string | null; + /** + * URL referencing a more detailed mitigation guide. + */ + referenceUrl?: string | null; + } /** * A rollout policy configuration. */ @@ -17644,7 +18316,7 @@ export namespace compute_alpha { */ nextHopInstance?: string | null; /** - * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. + * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment. */ nextHopInterconnectAttachment?: string | null; /** @@ -17675,6 +18347,10 @@ export namespace compute_alpha { * The URL to a VpnTunnel that should handle matching packets. */ nextHopVpnTunnel?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$RouteParams; /** * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. */ @@ -17751,6 +18427,15 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Additional route parameters. + */ + export interface Schema$RouteParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$RoutePolicy { /** * An optional description of route policy. @@ -18803,7 +19488,7 @@ export namespace compute_alpha { */ provisioningModel?: string | null; /** - * Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. + * DEPRECATED: please use skipGuestOsShutdown. Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs. */ shutdownTimeout?: Schema$Duration; /** @@ -19095,7 +19780,7 @@ export namespace compute_alpha { jsonParsing?: string | null; logLevel?: string | null; /** - * The maximum request size chosen by the customer with Waf enabled. Currently only "8KB" and "128KB" are supported. Values are case insensitive. + * The maximum request size chosen by the customer with Waf enabled. Values supported are "8KB", "16KB, "32KB", "48KB" and "64KB". Values are case insensitive. */ requestBodyInspectionSize?: string | null; /** @@ -19788,6 +20473,10 @@ export namespace compute_alpha { * The url of a connected endpoint. */ endpoint?: string | null; + /** + * NAT IPs of the connected PSC endpoint and those of other endpoints propagated from it. + */ + natIps?: string[] | null; /** * The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to. */ @@ -20084,7 +20773,7 @@ export namespace compute_alpha { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange */ export interface Schema$Snapshot { /** @@ -20195,6 +20884,14 @@ export namespace compute_alpha { * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ snapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The unique ID of the snapshot group that this snapshot belongs to. + */ + snapshotGroupId?: string | null; + /** + * [Output only] The snapshot group that this snapshot belongs to. + */ + snapshotGroupName?: string | null; /** * Indicates the type of the snapshot. */ @@ -20291,6 +20988,77 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Represents a SnapshotGroup resource. A snapshot group is a set of snapshots that represents a point in time state of a consistency group. + */ + export interface Schema$SnapshotGroup { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * Optional. An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#snapshotGroup for SnapshotGroup resources. + */ + kind?: string | null; + /** + * Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] + */ + sourceInfo?: Schema$SnapshotGroupSourceInfo; + /** + * Input field for the source instant snapshot group. + */ + sourceInstantSnapshotGroup?: string | null; + /** + * [Output Only] + */ + sourceInstantSnapshotGroupInfo?: Schema$SnapshotGroupSourceInstantSnapshotGroupInfo; + /** + * [Output Only] + */ + status?: string | null; + } + export interface Schema$SnapshotGroupParameters { + /** + * URLs of the zones where disks should be replicated to. Only applicable for regional resources. + */ + replicaZones?: string[] | null; + /** + * The source snapshot group used to create disks. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshotGroups/snapshotGroup - projects/project/global/snapshotGroups/snapshotGroup - global/snapshotGroups/snapshotGroup + */ + sourceSnapshotGroup?: string | null; + /** + * URL of the disk type resource describing which disk type to use to create disks. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. + */ + type?: string | null; + } + export interface Schema$SnapshotGroupSourceInfo { + consistencyGroup?: string | null; + consistencyGroupId?: string | null; + } + export interface Schema$SnapshotGroupSourceInstantSnapshotGroupInfo { + instantSnapshotGroup?: string | null; + instantSnapshotGroupId?: string | null; + } /** * Contains a list of Snapshot resources. */ @@ -21481,6 +22249,10 @@ export namespace compute_alpha { * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. */ network?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$SubnetworkParams; /** * Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. */ @@ -21489,9 +22261,6 @@ export namespace compute_alpha { * This field is for internal use. This field can be both set at resource creation time and updated using patch. */ privateIpv6GoogleAccess?: string | null; - /** - * 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; /** * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. @@ -21525,6 +22294,18 @@ export namespace compute_alpha { * [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY */ state?: string | null; + /** + * Output only. [Output Only] The array of external IPv6 network ranges reserved from the subnetwork's external IPv6 range for system use. + */ + systemReservedExternalIpv6Ranges?: string[] | null; + /** + * Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. + */ + systemReservedInternalIpv6Ranges?: string[] | null; + /** + * Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + */ + utilizationDetails?: Schema$SubnetworkUtilizationDetails; /** * A repeated field indicating the VLAN IDs supported on this subnetwork. During Subnet creation, specifying vlan is valid only if enable_l2 is true. During Subnet Update, specifying vlan is allowed only for l2 enabled subnets. Restricted to only one VLAN. */ @@ -21626,6 +22407,15 @@ export namespace compute_alpha { */ metadataFields?: string[] | null; } + /** + * Additional subnetwork parameters. + */ + export interface Schema$SubnetworkParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * Represents a secondary IP range of a subnetwork. */ @@ -21680,6 +22470,45 @@ export namespace compute_alpha { export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { privateIpGoogleAccess?: boolean | null; } + /** + * The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + */ + export interface Schema$SubnetworkUtilizationDetails { + /** + * Utilizations of external IPV6 IP range. + */ + externalIpv6InstanceUtilization?: Schema$SubnetworkUtilizationDetailsIPV6Utilization; + /** + * Utilizations of external IPV6 IP range for NetLB. + */ + externalIpv6LbUtilization?: Schema$SubnetworkUtilizationDetailsIPV6Utilization; + /** + * Utilizations of internal IPV6 IP range. + */ + internalIpv6Utilization?: Schema$SubnetworkUtilizationDetailsIPV6Utilization; + /** + * Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty. + */ + ipv4Utilizations?: Schema$SubnetworkUtilizationDetailsIPV4Utilization[]; + } + /** + * The IPV4 utilization of a single IP range. + */ + export interface Schema$SubnetworkUtilizationDetailsIPV4Utilization { + /** + * Will be set for secondary range. Empty for primary IPv4 range. + */ + rangeName?: string | null; + totalAllocatedIp?: string | null; + totalFreeIp?: string | null; + } + /** + * The IPV6 utilization of a single IP range. + */ + export interface Schema$SubnetworkUtilizationDetailsIPV6Utilization { + totalAllocatedIp?: Schema$Uint128; + totalFreeIp?: Schema$Uint128; + } /** * Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. */ @@ -22974,6 +23803,14 @@ export namespace compute_alpha { * The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. */ latestWindowStartTime?: string | null; + /** + * Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. + */ + maintenanceOnShutdown?: boolean | null; + /** + * The reasons for the maintenance. Only valid for vms. + */ + maintenanceReasons?: string[] | null; maintenanceStatus?: string | null; /** * [Output Only] The start time window of the maintenance disruption. DEPRECATED: Use window_start_time instead. TimeWindow is a container for two strings that represent timestamps in "yyyy-MM-dd'T'HH:mm:ssZ" text format. @@ -23279,9 +24116,6 @@ export namespace compute_alpha { * Network URL. */ network?: string | null; - /** - * 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; /** * The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -64292,101 +65126,6 @@ export namespace compute_alpha { 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$Interconnectlocations$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Interconnectlocations$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Interconnectlocations$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Interconnectlocations$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Interconnectlocations$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Interconnectlocations$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectlocations$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Interconnectlocations$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}/global/interconnectLocations/{resource}/testIamPermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Interconnectlocations$Get @@ -64427,22 +65166,6 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Interconnectlocations$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } export class Resource$Interconnectremotelocations { context: APIRequestContext; @@ -64641,102 +65364,6 @@ export namespace compute_alpha { ); } } - - /** - * 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$Interconnectremotelocations$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Interconnectremotelocations$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Interconnectremotelocations$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Interconnectremotelocations$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Interconnectremotelocations$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Interconnectremotelocations$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Interconnectremotelocations$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Interconnectremotelocations$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}/global/interconnectRemoteLocations/{resource}/testIamPermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Interconnectremotelocations$Get @@ -64777,22 +65404,6 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Interconnectremotelocations$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } export class Resource$Interconnects { context: APIRequestContext; @@ -67774,6 +68385,94 @@ export namespace compute_alpha { } } + /** + * Sets the labels on a machine image. 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$Machineimages$Setlabels, + options: StreamMethodOptions + ): GaxiosPromise; + setLabels( + params?: Params$Resource$Machineimages$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Machineimages$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$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}/global/machineImages/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', '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. * @@ -67974,6 +68673,22 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } + export interface Params$Resource$Machineimages$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } export interface Params$Resource$Machineimages$Testiampermissions extends StandardParameters { /** @@ -74684,6 +75399,96 @@ export namespace compute_alpha { } } + /** + * Requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, + options: StreamMethodOptions + ): GaxiosPromise; + requestRemovePeering( + params?: Params$Resource$Networks$Requestremovepeering, + options?: MethodOptions + ): GaxiosPromise; + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestRemovePeering( + params: Params$Resource$Networks$Requestremovepeering, + callback: BodyResponseCallback + ): void; + requestRemovePeering( + callback: BodyResponseCallback + ): void; + requestRemovePeering( + paramsOrCallback?: + | Params$Resource$Networks$Requestremovepeering + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Requestremovepeering; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Requestremovepeering; + 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/networks/{network}/requestRemovePeering' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Switches the network mode from auto subnet mode to custom subnet mode. * @@ -75220,6 +76025,26 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworksRemovePeeringRequest; } + export interface Params$Resource$Networks$Requestremovepeering + extends StandardParameters { + /** + * Name of the network resource to remove peering from. + */ + network?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksRequestRemovePeeringRequest; + } export interface Params$Resource$Networks$Switchtocustommode extends StandardParameters { /** @@ -80741,64 +81566,64 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Projects { + export class Resource$Previewfeatures { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Disable this project as a shared VPC host project. + * Returns the details of the given PreviewFeature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, + get( + params: Params$Resource$Previewfeatures$Get, options: StreamMethodOptions ): GaxiosPromise; - disableXpnHost( - params?: Params$Resource$Projects$Disablexpnhost, + get( + params?: Params$Resource$Previewfeatures$Get, options?: MethodOptions - ): GaxiosPromise; - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, + ): GaxiosPromise; + get( + params: Params$Resource$Previewfeatures$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Previewfeatures$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableXpnHost( - params: Params$Resource$Projects$Disablexpnhost, - callback: BodyResponseCallback + get( + params: Params$Resource$Previewfeatures$Get, + callback: BodyResponseCallback ): void; - disableXpnHost(callback: BodyResponseCallback): void; - disableXpnHost( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Disablexpnhost - | BodyResponseCallback + | Params$Resource$Previewfeatures$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$Disablexpnhost; + {}) as Params$Resource$Previewfeatures$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Disablexpnhost; + params = {} as Params$Resource$Previewfeatures$Get; options = {}; } @@ -80812,80 +81637,84 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/disableXpnHost' + rootUrl + + '/compute/alpha/projects/{project}/global/previewFeatures/{resourceId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'resourceId'], + pathParams: ['project', 'resourceId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Disable a service resource (also known as service project) associated with this host project. + * Returns the details of the given PreviewFeature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, + list( + params: Params$Resource$Previewfeatures$List, options: StreamMethodOptions ): GaxiosPromise; - disableXpnResource( - params?: Params$Resource$Projects$Disablexpnresource, + list( + params?: Params$Resource$Previewfeatures$List, options?: MethodOptions - ): GaxiosPromise; - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, + ): GaxiosPromise; + list( + params: Params$Resource$Previewfeatures$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Previewfeatures$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableXpnResource( - params: Params$Resource$Projects$Disablexpnresource, - callback: BodyResponseCallback + list( + params: Params$Resource$Previewfeatures$List, + callback: BodyResponseCallback ): void; - disableXpnResource(callback: BodyResponseCallback): void; - disableXpnResource( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Disablexpnresource - | BodyResponseCallback + | Params$Resource$Previewfeatures$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$Disablexpnresource; + {}) as Params$Resource$Previewfeatures$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Disablexpnresource; + params = {} as Params$Resource$Previewfeatures$List; options = {}; } @@ -80899,9 +81728,10 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/disableXpnResource' + rootUrl + + '/compute/alpha/projects/{project}/global/previewFeatures' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -80912,49 +81742,49 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Enable this project as a shared VPC host project. + * Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + update( + params: Params$Resource$Previewfeatures$Update, options: StreamMethodOptions ): GaxiosPromise; - enableXpnHost( - params?: Params$Resource$Projects$Enablexpnhost, + update( + params?: Params$Resource$Previewfeatures$Update, options?: MethodOptions ): GaxiosPromise; - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + update( + params: Params$Resource$Previewfeatures$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + update( + params: Params$Resource$Previewfeatures$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableXpnHost( - params: Params$Resource$Projects$Enablexpnhost, + update( + params: Params$Resource$Previewfeatures$Update, callback: BodyResponseCallback ): void; - enableXpnHost(callback: BodyResponseCallback): void; - enableXpnHost( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Projects$Enablexpnhost + | Params$Resource$Previewfeatures$Update | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80967,12 +81797,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Enablexpnhost; + {}) as Params$Resource$Previewfeatures$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Enablexpnhost; + params = {} as Params$Resource$Previewfeatures$Update; options = {}; } @@ -80986,16 +81816,17 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/enableXpnHost' + rootUrl + + '/compute/alpha/projects/{project}/global/previewFeatures/{resourceId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'resourceId'], + pathParams: ['project', 'resourceId'], context: this.context, }; if (callback) { @@ -81007,41 +81838,107 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Previewfeatures$Get + extends StandardParameters { /** - * Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. + * Project ID for this request. + */ + project?: string; + /** + * Name of the PreviewFeature for this request. + */ + resourceId?: string; + } + export interface Params$Resource$Previewfeatures$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$Previewfeatures$Update + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the PreviewFeature for this request. + */ + resourceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PreviewFeature; + } + + export class Resource$Projects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Disable this project as a shared VPC host 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. */ - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, options: StreamMethodOptions ): GaxiosPromise; - enableXpnResource( - params?: Params$Resource$Projects$Enablexpnresource, + disableXpnHost( + params?: Params$Resource$Projects$Disablexpnhost, options?: MethodOptions ): GaxiosPromise; - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableXpnResource( - params: Params$Resource$Projects$Enablexpnresource, + disableXpnHost( + params: Params$Resource$Projects$Disablexpnhost, callback: BodyResponseCallback ): void; - enableXpnResource(callback: BodyResponseCallback): void; - enableXpnResource( + disableXpnHost(callback: BodyResponseCallback): void; + disableXpnHost( paramsOrCallback?: - | Params$Resource$Projects$Enablexpnresource + | Params$Resource$Projects$Disablexpnhost | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81054,12 +81951,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Enablexpnresource; + {}) as Params$Resource$Projects$Disablexpnhost; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Enablexpnresource; + params = {} as Params$Resource$Projects$Disablexpnhost; options = {}; } @@ -81073,7 +81970,268 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/enableXpnResource' + rootUrl + '/compute/alpha/projects/{project}/disableXpnHost' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disable a service resource (also known as service project) associated with this host 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. + */ + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, + options: StreamMethodOptions + ): GaxiosPromise; + disableXpnResource( + params?: Params$Resource$Projects$Disablexpnresource, + options?: MethodOptions + ): GaxiosPromise; + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disableXpnResource( + params: Params$Resource$Projects$Disablexpnresource, + callback: BodyResponseCallback + ): void; + disableXpnResource(callback: BodyResponseCallback): void; + disableXpnResource( + paramsOrCallback?: + | Params$Resource$Projects$Disablexpnresource + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Disablexpnresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Disablexpnresource; + 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}/disableXpnResource' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Enable this project as a shared VPC host 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. + */ + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, + options: StreamMethodOptions + ): GaxiosPromise; + enableXpnHost( + params?: Params$Resource$Projects$Enablexpnhost, + options?: MethodOptions + ): GaxiosPromise; + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableXpnHost( + params: Params$Resource$Projects$Enablexpnhost, + callback: BodyResponseCallback + ): void; + enableXpnHost(callback: BodyResponseCallback): void; + enableXpnHost( + paramsOrCallback?: + | Params$Resource$Projects$Enablexpnhost + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Enablexpnhost; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Enablexpnhost; + 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}/enableXpnHost' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service 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. + */ + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, + options: StreamMethodOptions + ): GaxiosPromise; + enableXpnResource( + params?: Params$Resource$Projects$Enablexpnresource, + options?: MethodOptions + ): GaxiosPromise; + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableXpnResource( + params: Params$Resource$Projects$Enablexpnresource, + callback: BodyResponseCallback + ): void; + enableXpnResource(callback: BodyResponseCallback): void; + enableXpnResource( + paramsOrCallback?: + | Params$Resource$Projects$Enablexpnresource + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Enablexpnresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Enablexpnresource; + 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}/enableXpnResource' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -112115,6 +113273,237 @@ export namespace compute_alpha { returnPartialSuccess?: boolean; } + export class Resource$Reliabilityrisks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the specified ReliabilityRisk 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$Reliabilityrisks$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Reliabilityrisks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Reliabilityrisks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reliabilityrisks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reliabilityrisks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Reliabilityrisks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reliabilityrisks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reliabilityrisks$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}/global/reliabilityRisks/{reliabilityRisk}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'reliabilityRisk'], + pathParams: ['project', 'reliabilityRisk'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of reliabilityRisks available 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$Reliabilityrisks$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Reliabilityrisks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Reliabilityrisks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reliabilityrisks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reliabilityrisks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Reliabilityrisks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reliabilityrisks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reliabilityrisks$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}/global/reliabilityRisks' + ).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 + ); + } + } + } + + export interface Params$Resource$Reliabilityrisks$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the ReliabilityRisk resource to return. + */ + reliabilityRisk?: string; + } + export interface Params$Resource$Reliabilityrisks$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 class Resource$Reservationblocks { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -113734,6 +115123,383 @@ export namespace compute_alpha { requestBody?: Schema$Reservation; } + export class Resource$Reservationsubblocks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves information about the specified reservation subBlock. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reservationsubblocks$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Reservationsubblocks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Reservationsubblocks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservationsubblocks$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservationsubblocks$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'parentName', + 'reservationSubBlock', + ], + pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Retrieves a list of reservation subBlocks 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$Reservationsubblocks$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Reservationsubblocks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Reservationsubblocks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservationsubblocks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservationsubblocks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'parentName'], + pathParams: ['parentName', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Allows customers to perform maintenance on a reservation subBlock + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reservationsubblocks$Performmaintenance, + options: StreamMethodOptions + ): GaxiosPromise; + performMaintenance( + params?: Params$Resource$Reservationsubblocks$Performmaintenance, + options?: MethodOptions + ): GaxiosPromise; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + callback: BodyResponseCallback + ): void; + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$Performmaintenance + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$Performmaintenance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$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/alpha/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'parentName', + 'reservationSubBlock', + ], + pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reservationsubblocks$Get + extends StandardParameters { + /** + * The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + */ + parentName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID. + */ + reservationSubBlock?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Reservationsubblocks$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; + /** + * The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + */ + parentName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Reservationsubblocks$Performmaintenance + extends StandardParameters { + /** + * The name of the parent reservation and parent block. In the format of reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + */ + parentName?: 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 reservation subBlock. Name should conform to RFC1035 or be a resource ID. + */ + reservationSubBlock?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + } + export class Resource$Resourcepolicies { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -120322,6 +122088,10 @@ export namespace compute_alpha { * Name of the ServiceAttachment resource to return. */ serviceAttachment?: string; + /** + * Indicates whether NAT IPs should be included in the response. + */ + showNatIps?: boolean; } export interface Params$Resource$Serviceattachments$Getiampolicy extends StandardParameters { @@ -120458,108 +122228,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Snapshots { + export class Resource$Snapshotgroups { context: APIRequestContext; constructor(context: APIRequestContext) { 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/alpha/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. + * Deletes the specified SnapshotGroup resource * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -120567,31 +122243,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Snapshots$Delete, + params: Params$Resource$Snapshotgroups$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Snapshots$Delete, + params?: Params$Resource$Snapshotgroups$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Snapshots$Delete, + params: Params$Resource$Snapshotgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Snapshots$Delete, + params: Params$Resource$Snapshotgroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Snapshots$Delete, + params: Params$Resource$Snapshotgroups$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Snapshots$Delete + | Params$Resource$Snapshotgroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -120603,12 +122279,13 @@ export namespace compute_alpha { | BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshotgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$Delete; + params = {} as Params$Resource$Snapshotgroups$Delete; options = {}; } @@ -120623,7 +122300,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/snapshots/{snapshot}' + '/compute/alpha/projects/{project}/global/snapshotGroups/{snapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -120631,8 +122308,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'snapshot'], - pathParams: ['project', 'snapshot'], + requiredParams: ['project', 'snapshotGroup'], + pathParams: ['project', 'snapshotGroup'], context: this.context, }; if (callback) { @@ -120646,7 +122323,7 @@ export namespace compute_alpha { } /** - * Returns the specified Snapshot resource. + * returns the specified SnapshotGroup resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -120654,48 +122331,49 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Snapshots$Get, + params: Params$Resource$Snapshotgroups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Snapshots$Get, + params?: Params$Resource$Snapshotgroups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Snapshots$Get, + params: Params$Resource$Snapshotgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Snapshots$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Snapshotgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Snapshots$Get, - callback: BodyResponseCallback + params: Params$Resource$Snapshotgroups$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Snapshots$Get - | BodyResponseCallback + | Params$Resource$Snapshotgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Get; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshotgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$Get; + params = {} as Params$Resource$Snapshotgroups$Get; options = {}; } @@ -120710,7 +122388,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/snapshots/{snapshot}' + '/compute/alpha/projects/{project}/global/snapshotGroups/{snapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -120718,17 +122396,17 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'snapshot'], - pathParams: ['project', 'snapshot'], + requiredParams: ['project', 'snapshotGroup'], + pathParams: ['project', 'snapshotGroup'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -120741,31 +122419,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Snapshots$Getiampolicy, + params: Params$Resource$Snapshotgroups$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Snapshots$Getiampolicy, + params?: Params$Resource$Snapshotgroups$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Snapshots$Getiampolicy, + params: Params$Resource$Snapshotgroups$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Snapshots$Getiampolicy, + params: Params$Resource$Snapshotgroups$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Snapshots$Getiampolicy, + params: Params$Resource$Snapshotgroups$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy(callback: BodyResponseCallback): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Snapshots$Getiampolicy + | Params$Resource$Snapshotgroups$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -120778,12 +122456,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Snapshots$Getiampolicy; + {}) as Params$Resource$Snapshotgroups$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$Getiampolicy; + params = {} as Params$Resource$Snapshotgroups$Getiampolicy; options = {}; } @@ -120798,7 +122476,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/snapshots/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/global/snapshotGroups/{resource}/getIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -120821,7 +122499,7 @@ export namespace compute_alpha { } /** - * Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project. + * Creates a snapshot group 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`. @@ -120829,31 +122507,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Snapshots$Insert, + params: Params$Resource$Snapshotgroups$Insert, options: StreamMethodOptions ): GaxiosPromise; insert( - params?: Params$Resource$Snapshots$Insert, + params?: Params$Resource$Snapshotgroups$Insert, options?: MethodOptions ): GaxiosPromise; insert( - params: Params$Resource$Snapshots$Insert, + params: Params$Resource$Snapshotgroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Snapshots$Insert, + params: Params$Resource$Snapshotgroups$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Snapshots$Insert, + params: Params$Resource$Snapshotgroups$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Snapshots$Insert + | Params$Resource$Snapshotgroups$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -120865,12 +122543,13 @@ export namespace compute_alpha { | BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Insert; + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshotgroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$Insert; + params = {} as Params$Resource$Snapshotgroups$Insert; options = {}; } @@ -120884,7 +122563,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/snapshots' + rootUrl + + '/compute/alpha/projects/{project}/global/snapshotGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -120907,7 +122587,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of Snapshot resources contained within the specified project. + * retrieves the list of SnapshotGroup resources contained within the specified project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -120915,48 +122595,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Snapshots$List, + params: Params$Resource$Snapshotgroups$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Snapshots$List, + params?: Params$Resource$Snapshotgroups$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Snapshots$List, + params: Params$Resource$Snapshotgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Snapshots$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Snapshotgroups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Snapshots$List, - callback: BodyResponseCallback + params: Params$Resource$Snapshotgroups$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Snapshots$List - | BodyResponseCallback + | Params$Resource$Snapshotgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$List; + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshotgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$List; + params = {} as Params$Resource$Snapshotgroups$List; options = {}; } @@ -120970,7 +122654,8 @@ export namespace compute_alpha { options: Object.assign( { url: ( - rootUrl + '/compute/alpha/projects/{project}/global/snapshots' + rootUrl + + '/compute/alpha/projects/{project}/global/snapshotGroups' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -120983,12 +122668,12 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -121001,31 +122686,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Snapshots$Setiampolicy, + params: Params$Resource$Snapshotgroups$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Snapshots$Setiampolicy, + params?: Params$Resource$Snapshotgroups$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Snapshots$Setiampolicy, + params: Params$Resource$Snapshotgroups$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Snapshots$Setiampolicy, + params: Params$Resource$Snapshotgroups$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Snapshots$Setiampolicy, + params: Params$Resource$Snapshotgroups$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy(callback: BodyResponseCallback): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Snapshots$Setiampolicy + | Params$Resource$Snapshotgroups$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -121038,12 +122723,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Snapshots$Setiampolicy; + {}) as Params$Resource$Snapshotgroups$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$Setiampolicy; + params = {} as Params$Resource$Snapshotgroups$Setiampolicy; options = {}; } @@ -121058,7 +122743,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/snapshots/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/global/snapshotGroups/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -121080,94 +122765,6 @@ export namespace compute_alpha { } } - /** - * Sets the labels on a 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$Snapshots$Setlabels, - options: StreamMethodOptions - ): GaxiosPromise; - setLabels( - params?: Params$Resource$Snapshots$Setlabels, - options?: MethodOptions - ): GaxiosPromise; - setLabels( - params: Params$Resource$Snapshots$Setlabels, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setLabels( - params: Params$Resource$Snapshots$Setlabels, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setLabels( - params: Params$Resource$Snapshots$Setlabels, - callback: BodyResponseCallback - ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( - paramsOrCallback?: - | Params$Resource$Snapshots$Setlabels - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Snapshots$Setlabels; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$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}/global/snapshots/{resource}/setLabels' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'resource'], - pathParams: ['project', '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. * @@ -121177,27 +122774,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Snapshots$Testiampermissions, + params: Params$Resource$Snapshotgroups$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Snapshots$Testiampermissions, + params?: Params$Resource$Snapshotgroups$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Snapshots$Testiampermissions, + params: Params$Resource$Snapshotgroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Snapshots$Testiampermissions, + params: Params$Resource$Snapshotgroups$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Snapshots$Testiampermissions, + params: Params$Resource$Snapshotgroups$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -121205,7 +122802,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Snapshots$Testiampermissions + | Params$Resource$Snapshotgroups$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -121221,12 +122818,12 @@ export namespace compute_alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Snapshots$Testiampermissions; + {}) as Params$Resource$Snapshotgroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Snapshots$Testiampermissions; + params = {} as Params$Resource$Snapshotgroups$Testiampermissions; options = {}; } @@ -121241,7 +122838,930 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/snapshots/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/global/snapshotGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Snapshotgroups$Delete + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the SnapshotGroup resource to delete. + */ + snapshotGroup?: string; + } + export interface Params$Resource$Snapshotgroups$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the SnapshotGroup resource to return. + */ + snapshotGroup?: string; + } + export interface Params$Resource$Snapshotgroups$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Snapshotgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SnapshotGroup; + } + export interface Params$Resource$Snapshotgroups$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$Snapshotgroups$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Snapshotgroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Snapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + 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/alpha/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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Snapshots$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Snapshots$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Snapshots$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Snapshots$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Snapshots$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Snapshots$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{snapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'snapshot'], + pathParams: ['project', '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$Snapshots$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Snapshots$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Snapshots$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Snapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Snapshots$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Snapshots$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{snapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'snapshot'], + pathParams: ['project', '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$Snapshots$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Snapshots$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Snapshots$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Snapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Snapshots$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Snapshots$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this 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. + */ + insert( + params: Params$Resource$Snapshots$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Snapshots$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Snapshots$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Snapshots$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Snapshots$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Snapshots$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of Snapshot resources contained within 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$Snapshots$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Snapshots$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Snapshots$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Snapshots$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Snapshots$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Snapshots$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Snapshots$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/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); + } + } + + /** + * 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$Snapshots$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Snapshots$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Snapshots$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Snapshots$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Snapshots$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Snapshots$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the labels on a 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$Snapshots$Setlabels, + options: StreamMethodOptions + ): GaxiosPromise; + setLabels( + params?: Params$Resource$Snapshots$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Snapshots$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Snapshots$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Snapshots$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Snapshots$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', '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$Snapshots$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Snapshots$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Snapshots$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Snapshots$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Snapshots$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Snapshots$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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}/global/snapshots/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -126013,6 +128533,10 @@ export namespace compute_alpha { * Name of the Subnetwork resource to return. */ subnetwork?: string; + /** + * Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. + */ + views?: string[]; } export interface Params$Resource$Subnetworks$Getiampolicy extends StandardParameters { @@ -126082,6 +128606,10 @@ export namespace compute_alpha { * 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; + /** + * Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. + */ + views?: string[]; } export interface Params$Resource$Subnetworks$Listusable extends StandardParameters { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index bffcae5d465..2740e45b6dc 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -1478,7 +1478,7 @@ export namespace compute_beta { */ failover?: boolean | null; /** - * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. + * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP. */ group?: string | null; /** @@ -1596,7 +1596,7 @@ export namespace compute_beta { */ clientTtl?: number | null; /** - * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. + * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. */ defaultTtl?: number | null; /** @@ -1616,7 +1616,7 @@ export namespace compute_beta { */ requestCoalescing?: boolean | null; /** - * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. + * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. */ serveWhileStale?: number | null; /** @@ -1770,9 +1770,12 @@ export namespace compute_beta { * Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. */ compressionMode?: string | null; + /** + * connectionDraining cannot be specified with haPolicy. + */ connectionDraining?: Schema$ConnectionDraining; /** - * Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. + * Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy. */ connectionTrackingPolicy?: Schema$BackendServiceConnectionTrackingPolicy; /** @@ -1820,7 +1823,7 @@ export namespace compute_beta { */ externalManagedMigrationTestingPercentage?: number | null; /** - * Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). + * Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy. */ failoverPolicy?: Schema$BackendServiceFailoverPolicy; /** @@ -1828,7 +1831,11 @@ export namespace compute_beta { */ fingerprint?: string | null; /** - * The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. + * Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers. + */ + haPolicy?: Schema$BackendServiceHAPolicy; + /** + * The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy. */ healthChecks?: string[] | null; /** @@ -1856,7 +1863,7 @@ export namespace compute_beta { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy. */ localityLbPolicy?: string | null; /** @@ -1876,11 +1883,11 @@ export namespace compute_beta { */ name?: string | null; /** - * 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. + * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. 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. + * Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy. */ networkPassThroughLbTrafficPolicy?: Schema$BackendServiceNetworkPassThroughLbTrafficPolicy; /** @@ -1924,13 +1931,16 @@ export namespace compute_beta { */ serviceLbPolicy?: string | null; /** - * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy. */ sessionAffinity?: string | null; /** * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. */ strongSessionAffinityCookie?: Schema$BackendServiceHttpCookie; + /** + * subsetting cannot be specified with haPolicy. + */ subsetting?: Schema$Subsetting; /** * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. @@ -2003,7 +2013,7 @@ export namespace compute_beta { */ clientTtl?: number | null; /** - * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. + * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. */ defaultTtl?: number | null; /** @@ -2023,7 +2033,7 @@ export namespace compute_beta { */ requestCoalescing?: boolean | null; /** - * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. + * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. */ serveWhileStale?: number | null; /** @@ -2140,6 +2150,12 @@ export namespace compute_beta { */ kind?: string | null; } + export interface Schema$BackendServiceHAPolicy { + /** + * Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to update the leader. - \>GARP_RA: Provides a method to very quickly define a new network endpoint as the leader. This method is faster than updating the leader using the haPolicy.leader API. Fast IP move works as follows: The VM hosting the network endpoint that should become the new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays active for approximately 20 minutes. After triggering fast failover, you must also appropriately set the haPolicy.leader. - The new leader instance should continue to send GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from different VM instances at the same time. If multiple instances continue to send GARP/RA packets, traffic might be routed to different destinations in an alternating order. This condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always takes priority over the leader API. Using the haPolicy.leader API to change the leader to a different instance will have no effect until the GARP/RA request becomes inactive. - The GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding rules refer to a regional backend service, you need only send a GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend service will also be moved to the sender of the GARP or RA packet. The following are the Fast IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED. + */ + fastIPMove?: string | null; + } /** * The HTTP cookie used for stateful session affinity. */ @@ -2648,7 +2664,7 @@ export namespace compute_beta { } 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. + * 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; /** @@ -3053,10 +3069,6 @@ export namespace compute_beta { * [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. @@ -4040,6 +4052,10 @@ export namespace compute_beta { * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$FirewallParams; /** * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ @@ -4115,6 +4131,15 @@ export namespace compute_beta { */ metadata?: string | null; } + /** + * Additional firewall parameters. + */ + export interface Schema$FirewallParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$FirewallPoliciesListAssociationsResponse { /** * A list of associations. @@ -4225,6 +4250,10 @@ export namespace compute_beta { * The name for an association. */ name?: string | null; + /** + * An integer indicating the priority of an association. The priority must be a positive value between 1 and 2147483647. Firewall Policies are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority. The default value is `1000`. If two associations have the same priority then lexicographical order on association names is applied. + */ + priority?: number | null; /** * [Output Only] The short name of the firewall policy of the association. */ @@ -5232,6 +5261,20 @@ export namespace compute_beta { */ portSpecification?: string | null; } + export interface Schema$GRPCTLSHealthCheck { + /** + * The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII. + */ + grpcServiceName?: string | null; + /** + * The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * 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. + */ + portSpecification?: string | null; + } /** * A guest attributes entry. */ @@ -5289,7 +5332,7 @@ export namespace compute_beta { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. + * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features. */ type?: string | null; } @@ -5310,6 +5353,7 @@ export namespace compute_beta { */ description?: string | null; grpcHealthCheck?: Schema$GRPCHealthCheck; + grpcTlsHealthCheck?: Schema$GRPCTLSHealthCheck; /** * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. */ @@ -7124,7 +7168,7 @@ export namespace compute_beta { } export interface Schema$InstanceGroupManagerInstanceLifecyclePolicy { /** - * The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. + * The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed VM. */ defaultActionOnFailure?: string | null; /** @@ -7198,6 +7242,10 @@ export namespace compute_beta { * [Output Only] A unique identifier for this resource type. The server generates this identifier. */ id?: string | null; + /** + * The names of instances to be created by this resize request. The number of names specified determines the number of instances to create. The group's target size will be increased by this number. This field cannot be used together with 'resize_by'. + */ + instances?: Schema$PerInstanceConfig[]; /** * [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests. */ @@ -8052,7 +8100,7 @@ export namespace compute_beta { } export interface Schema$InstancesReportHostAsFaultyRequest { /** - * The disruption schedule for the VM. Default to IMMEDIATE. + * The disruption schedule for the VM. Required field, only allows IMMEDIATE. */ disruptionSchedule?: string | null; faultReasons?: Schema$InstancesReportHostAsFaultyRequestFaultReason[]; @@ -8539,7 +8587,7 @@ export namespace compute_beta { */ labels?: {[key: string]: 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. + * 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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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; /** @@ -9100,7 +9148,7 @@ export namespace compute_beta { */ availableFeatures?: string[] | null; /** - * [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR + * [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 */ availableLinkTypes?: string[] | null; /** @@ -9710,6 +9758,14 @@ export namespace compute_beta { * [Output Only] The resource type, which is always compute#machineImage for machine image. */ kind?: string | null; + /** + * A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this machine image. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; /** * Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later. */ @@ -10289,6 +10345,10 @@ export namespace compute_beta { * A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version\}/projects/{project_id\}/global/networkProfiles/{network_profile_name\} - projects/{project_id\}/global/networkProfiles/{network_profile_name\} */ networkProfile?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$NetworkParams; /** * [Output Only] A list of network peerings for the resource. */ @@ -11087,6 +11147,15 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Additional network parameters. + */ + export interface Schema$NetworkParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. */ @@ -11124,7 +11193,7 @@ export namespace compute_beta { */ network?: string | null; /** - * Maximum Transmission Unit in bytes. + * [Output Only] Maximum Transmission Unit in bytes of the peer network. */ peerMtu?: number | null; /** @@ -11213,6 +11282,10 @@ export namespace compute_beta { * Specifies whether cloud router creation is allowed. */ allowCloudRouter?: string | null; + /** + * Specifies whether default NIC attachment is allowed. + */ + allowDefaultNicAttachment?: string | null; /** * Specifies whether VMs are allowed to have external IP access on network interfaces connected to this VPC. */ @@ -11221,6 +11294,10 @@ export namespace compute_beta { * Specifies whether Cloud Interconnect creation is allowed. */ allowInterconnect?: string | null; + /** + * Specifies whether IP forwarding is allowed. + */ + allowIpForwarding?: string | null; /** * Specifies whether cloud load balancing is allowed. */ @@ -11229,6 +11306,14 @@ export namespace compute_beta { * Specifies whether multi-nic in the same network is allowed. */ allowMultiNicInSameNetwork?: string | null; + /** + * Specifies whether NCC is allowed. + */ + allowNcc?: string | null; + /** + * Specifies whether VM network migration is allowed. + */ + allowNetworkMigration?: string | null; /** * Specifies whether Packet Mirroring 1.0 is supported. */ @@ -11273,6 +11358,14 @@ export namespace compute_beta { * Specifies which subnetwork stack types are supported. */ subnetStackTypes?: string[] | null; + /** + * Specifies which subnetwork purposes are supported. + */ + subnetworkPurposes?: string[] | null; + /** + * Specifies which subnetwork stack types are supported. + */ + subnetworkStackTypes?: string[] | null; /** * Specifies which type of unicast is supported. */ @@ -13935,6 +14028,10 @@ export namespace compute_beta { * [Output Only] Type of the resource. Always compute#reservations for reservations. */ kind?: string | null; + /** + * [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments. + */ + linkedCommitments?: string[] | null; /** * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -14535,6 +14632,10 @@ export namespace compute_beta { * 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). */ @@ -14693,7 +14794,7 @@ export namespace compute_beta { */ nextHopInstance?: string | null; /** - * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. + * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment. */ nextHopInterconnectAttachment?: string | null; /** @@ -14724,6 +14825,10 @@ export namespace compute_beta { * The URL to a VpnTunnel that should handle matching packets. */ nextHopVpnTunnel?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$RouteParams; /** * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. */ @@ -14796,6 +14901,15 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Additional route parameters. + */ + export interface Schema$RouteParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$RoutePolicy { /** * An optional description of route policy. @@ -16911,7 +17025,7 @@ export namespace compute_beta { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange */ export interface Schema$Snapshot { /** @@ -18218,6 +18332,10 @@ export namespace compute_beta { * The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. */ network?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$SubnetworkParams; /** * Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. */ @@ -18226,9 +18344,6 @@ export namespace compute_beta { * This field is for internal use. This field can be both set at resource creation time and updated using patch. */ privateIpv6GoogleAccess?: string | null; - /** - * 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; /** * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. @@ -18355,6 +18470,15 @@ export namespace compute_beta { */ metadataFields?: string[] | null; } + /** + * Additional subnetwork parameters. + */ + export interface Schema$SubnetworkParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * Represents a secondary IP range of a subnetwork. */ @@ -19591,6 +19715,10 @@ export namespace compute_beta { * The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. */ latestWindowStartTime?: string | null; + /** + * Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. + */ + maintenanceOnShutdown?: boolean | null; maintenanceStatus?: string | null; /** * Defines the type of maintenance. @@ -19873,9 +20001,6 @@ export namespace compute_beta { * Network URL. */ network?: string | null; - /** - * 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; /** * The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -20557,7 +20682,6 @@ export namespace compute_beta { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; - selfLinkWithId?: string | null; /** * Topology details for the wire group configuration. */ @@ -59910,6 +60034,94 @@ export namespace compute_beta { } } + /** + * Sets the labels on a machine image. 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$Machineimages$Setlabels, + options: StreamMethodOptions + ): GaxiosPromise; + setLabels( + params?: Params$Resource$Machineimages$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Machineimages$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$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}/global/machineImages/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', '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. * @@ -60110,6 +60322,22 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetPolicyRequest; } + export interface Params$Resource$Machineimages$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } export interface Params$Resource$Machineimages$Testiampermissions extends StandardParameters { /** @@ -90670,6 +90898,95 @@ export namespace compute_beta { } } + /** + * Updates an association for the specified network 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. + */ + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, + options: StreamMethodOptions + ): GaxiosPromise; + patchAssociation( + params?: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, + options?: MethodOptions + ): GaxiosPromise; + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchAssociation( + params: Params$Resource$Regionnetworkfirewallpolicies$Patchassociation, + callback: BodyResponseCallback + ): void; + patchAssociation(callback: BodyResponseCallback): void; + patchAssociation( + paramsOrCallback?: + | Params$Resource$Regionnetworkfirewallpolicies$Patchassociation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkfirewallpolicies$Patchassociation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkfirewallpolicies$Patchassociation; + 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}/firewallPolicies/{firewallPolicy}/patchAssociation' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Patches a rule of the specified priority. * @@ -91123,6 +91440,10 @@ export namespace compute_beta { export interface Params$Resource$Regionnetworkfirewallpolicies$Addassociation extends StandardParameters { + /** + * Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'. + */ + associatedPolicyToBeReplaced?: string; /** * Name of the firewall policy to update. */ @@ -91385,6 +91706,30 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicy; } + export interface Params$Resource$Regionnetworkfirewallpolicies$Patchassociation + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: 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$FirewallPolicyAssociation; + } export interface Params$Resource$Regionnetworkfirewallpolicies$Patchrule extends StandardParameters { /** diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 1c1bcadc281..737b4f2f7f0 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -191,6 +191,7 @@ export namespace compute_v1 { regionTargetTcpProxies: Resource$Regiontargettcpproxies; regionUrlMaps: Resource$Regionurlmaps; regionZones: Resource$Regionzones; + reservationBlocks: Resource$Reservationblocks; reservations: Resource$Reservations; resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; @@ -345,6 +346,7 @@ export namespace compute_v1 { ); this.regionUrlMaps = new Resource$Regionurlmaps(this.context); this.regionZones = new Resource$Regionzones(this.context); + this.reservationBlocks = new Resource$Reservationblocks(this.context); this.reservations = new Resource$Reservations(this.context); this.resourcePolicies = new Resource$Resourcepolicies(this.context); this.routers = new Resource$Routers(this.context); @@ -809,6 +811,14 @@ export namespace compute_v1 { * [Output Only] Contains output only fields. */ export interface Schema$AllocationResourceStatus { + /** + * The number of reservation blocks associated with this reservation. + */ + reservationBlockCount?: number | null; + /** + * Maintenance information for this reservation + */ + reservationMaintenance?: Schema$GroupMaintenanceInfo; /** * Allocation Properties of this reservation. */ @@ -1400,7 +1410,7 @@ export namespace compute_v1 { */ failover?: boolean | null; /** - * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. + * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP. */ group?: string | null; /** @@ -1514,7 +1524,7 @@ export namespace compute_v1 { */ clientTtl?: number | null; /** - * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. + * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. */ defaultTtl?: number | null; /** @@ -1534,7 +1544,7 @@ export namespace compute_v1 { */ requestCoalescing?: boolean | null; /** - * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. + * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. */ serveWhileStale?: number | null; /** @@ -1658,9 +1668,12 @@ export namespace compute_v1 { * Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. */ compressionMode?: string | null; + /** + * connectionDraining cannot be specified with haPolicy. + */ connectionDraining?: Schema$ConnectionDraining; /** - * Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. + * Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy. */ connectionTrackingPolicy?: Schema$BackendServiceConnectionTrackingPolicy; /** @@ -1696,7 +1709,15 @@ export namespace compute_v1 { */ enableCDN?: boolean | null; /** - * Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). + * Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + */ + externalManagedMigrationState?: string | null; + /** + * Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. + */ + externalManagedMigrationTestingPercentage?: number | null; + /** + * Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy. */ failoverPolicy?: Schema$BackendServiceFailoverPolicy; /** @@ -1704,7 +1725,11 @@ export namespace compute_v1 { */ fingerprint?: string | null; /** - * The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. + * Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers. + */ + haPolicy?: Schema$BackendServiceHAPolicy; + /** + * The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy. */ healthChecks?: string[] | null; /** @@ -1732,7 +1757,7 @@ export namespace compute_v1 { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy. */ localityLbPolicy?: string | null; /** @@ -1752,7 +1777,7 @@ export namespace compute_v1 { */ name?: string | null; /** - * 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. + * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL. */ network?: string | null; /** @@ -1796,13 +1821,16 @@ export namespace compute_v1 { */ serviceLbPolicy?: string | null; /** - * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy. */ sessionAffinity?: string | null; /** * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. */ strongSessionAffinityCookie?: Schema$BackendServiceHttpCookie; + /** + * subsetting cannot be specified with haPolicy. + */ subsetting?: Schema$Subsetting; /** * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. @@ -1871,7 +1899,7 @@ export namespace compute_v1 { */ clientTtl?: number | null; /** - * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. + * Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. */ defaultTtl?: number | null; /** @@ -1891,7 +1919,7 @@ export namespace compute_v1 { */ requestCoalescing?: boolean | null; /** - * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. + * Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. */ serveWhileStale?: number | null; /** @@ -1990,6 +2018,12 @@ export namespace compute_v1 { */ kind?: string | null; } + export interface Schema$BackendServiceHAPolicy { + /** + * Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to update the leader. - \>GARP_RA: Provides a method to very quickly define a new network endpoint as the leader. This method is faster than updating the leader using the haPolicy.leader API. Fast IP move works as follows: The VM hosting the network endpoint that should become the new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays active for approximately 20 minutes. After triggering fast failover, you must also appropriately set the haPolicy.leader. - The new leader instance should continue to send GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from different VM instances at the same time. If multiple instances continue to send GARP/RA packets, traffic might be routed to different destinations in an alternating order. This condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always takes priority over the leader API. Using the haPolicy.leader API to change the leader to a different instance will have no effect until the GARP/RA request becomes inactive. - The GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding rules refer to a regional backend service, you need only send a GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend service will also be moved to the sender of the GARP or RA packet. The following are the Fast IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED. + */ + fastIPMove?: string | null; + } /** * The HTTP cookie used for stateful session affinity. */ @@ -2438,6 +2472,10 @@ export namespace compute_v1 { targetVmCount?: number | null; } export interface Schema$CacheInvalidationRule { + /** + * 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. */ @@ -4350,6 +4388,27 @@ export namespace compute_v1 { */ policy?: Schema$Policy; } + /** + * Maintenance Info for ReservationBlocks. + */ + export interface Schema$GroupMaintenanceInfo { + /** + * Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. + */ + maintenanceOngoingCount?: number | null; + /** + * Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. + */ + maintenancePendingCount?: number | null; + /** + * The type of maintenance for the reservation. + */ + schedulingType?: string | null; + /** + * Maintenance information on this group of VMs. + */ + upcomingGroupMaintenance?: Schema$UpcomingMaintenance; + } export interface Schema$GRPCHealthCheck { /** * The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII. @@ -4425,7 +4484,7 @@ export namespace compute_v1 { */ export interface Schema$GuestOsFeature { /** - * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features. + * The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features. */ type?: string | null; } @@ -7022,7 +7081,7 @@ export namespace compute_v1 { } export interface Schema$InstancesReportHostAsFaultyRequest { /** - * The disruption schedule for the VM. Default to IMMEDIATE. + * The disruption schedule for the VM. Required field, only allows IMMEDIATE. */ disruptionSchedule?: string | null; faultReasons?: Schema$InstancesReportHostAsFaultyRequestFaultReason[]; @@ -7491,7 +7550,7 @@ export namespace compute_v1 { */ labels?: {[key: string]: 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. + * 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. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 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; /** @@ -8010,7 +8069,7 @@ export namespace compute_v1 { */ availableFeatures?: string[] | null; /** - * [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR + * [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 */ availableLinkTypes?: string[] | null; /** @@ -8607,6 +8666,14 @@ export namespace compute_v1 { * [Output Only] The resource type, which is always compute#machineImage for machine image. */ kind?: string | null; + /** + * A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this machine image. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; /** * Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later. */ @@ -9861,7 +9928,7 @@ export namespace compute_v1 { */ network?: string | null; /** - * Maximum Transmission Unit in bytes. + * [Output Only] Maximum Transmission Unit in bytes of the peer network. */ peerMtu?: number | null; /** @@ -9950,6 +10017,10 @@ export namespace compute_v1 { * Specifies whether cloud router creation is allowed. */ allowCloudRouter?: string | null; + /** + * Specifies whether default NIC attachment is allowed. + */ + allowDefaultNicAttachment?: string | null; /** * Specifies whether VMs are allowed to have external IP access on network interfaces connected to this VPC. */ @@ -9958,6 +10029,10 @@ export namespace compute_v1 { * Specifies whether Cloud Interconnect creation is allowed. */ allowInterconnect?: string | null; + /** + * Specifies whether IP forwarding is allowed. + */ + allowIpForwarding?: string | null; /** * Specifies whether cloud load balancing is allowed. */ @@ -9966,6 +10041,14 @@ export namespace compute_v1 { * Specifies whether multi-nic in the same network is allowed. */ allowMultiNicInSameNetwork?: string | null; + /** + * Specifies whether NCC is allowed. + */ + allowNcc?: string | null; + /** + * Specifies whether VM network migration is allowed. + */ + allowNetworkMigration?: string | null; /** * Specifies whether Packet Mirroring 1.0 is supported. */ @@ -10010,6 +10093,14 @@ export namespace compute_v1 { * Specifies which subnetwork stack types are supported. */ subnetStackTypes?: string[] | null; + /** + * Specifies which subnetwork purposes are supported. + */ + subnetworkPurposes?: string[] | null; + /** + * Specifies which subnetwork stack types are supported. + */ + subnetworkStackTypes?: string[] | null; /** * Specifies which type of unicast is supported. */ @@ -12540,6 +12631,10 @@ export namespace compute_v1 { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; + /** + * Specifies the deployment strategy for this reservation. + */ + deploymentType?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -12552,6 +12647,10 @@ export namespace compute_v1 { * [Output Only] Type of the resource. Always compute#reservations for reservations. */ kind?: string | null; + /** + * [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments. + */ + linkedCommitments?: string[] | null; /** * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -12651,6 +12750,105 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * Represents a reservation block resource. + */ + export interface Schema$ReservationBlock { + /** + * [Output Only] The number of resources that are allocated in this reservation block. + */ + count?: number | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] The number of instances that are currently in use on this reservation block. + */ + inUseCount?: number | null; + /** + * [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks. + */ + kind?: string | null; + /** + * [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61\}[a-z0-9])? + */ + name?: string | null; + /** + * [Output Only] The physical topology of the reservation block. + */ + physicalTopology?: Schema$ReservationBlockPhysicalTopology; + /** + * [Output Only] Maintenance information for this reservation block. + */ + reservationMaintenance?: Schema$GroupMaintenanceInfo; + /** + * [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] Status of the reservation block. + */ + status?: string | null; + /** + * [Output Only] Zone in which the reservation block resides. + */ + zone?: string | null; + } + export interface Schema$ReservationBlockPhysicalTopology { + /** + * The hash of the capacity block within the cluster. + */ + block?: string | null; + /** + * The cluster name of the reservation block. + */ + cluster?: string | null; + } + export interface Schema$ReservationBlocksGetResponse { + resource?: Schema$ReservationBlock; + } + /** + * A list of reservation blocks under a single reservation. + */ + export interface Schema$ReservationBlocksListResponse { + /** + * Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of reservation block resources. + */ + items?: Schema$ReservationBlock[]; + /** + * Type of the resource. Always compute#reservationBlock for a list of reservation blocks. + */ + 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; + /** + * 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$ReservationList { /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. @@ -12681,6 +12879,18 @@ export namespace compute_v1 { 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. @@ -13656,6 +13866,10 @@ export namespace compute_v1 { * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. */ name?: string | null; + /** + * List of Subnetwork resources whose traffic should be translated by NAT64 Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is selected for the SubnetworkIpRangeToNat64Option above. + */ + nat64Subnetworks?: Schema$RouterNatSubnetworkToNat64[]; /** * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. */ @@ -13672,6 +13886,10 @@ export namespace compute_v1 { * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string | null; + /** + * Specify the Nat option for NAT64, which can take one of the following values: - ALL_IPV6_SUBNETWORKS: All of the IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field nat64_subnetwork below) The default is NAT64_OPTION_UNSPECIFIED. Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other Router.Nat section in this region can also enable NAT64 for any Subnetworks in this network. Other Router.Nat sections can still be present to enable NAT44 only. + */ + sourceSubnetworkIpRangesToNat64?: string | null; /** * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. */ @@ -13763,6 +13981,15 @@ export namespace compute_v1 { */ sourceIpRangesToNat?: string[] | null; } + /** + * Specifies a subnetwork to enable NAT64. + */ + export interface Schema$RouterNatSubnetworkToNat64 { + /** + * URL for the subnetwork resource that will use NAT64. + */ + name?: string | null; + } export interface Schema$RoutersGetRoutePolicyResponse { resource?: Schema$RoutePolicy; } @@ -15127,7 +15354,7 @@ export namespace compute_v1 { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange */ export interface Schema$Snapshot { /** @@ -15166,6 +15393,10 @@ export namespace compute_v1 { * Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk. */ enableConfidentialCompute?: boolean | null; + /** + * [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. + */ + guestFlush?: boolean | null; /** * [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -16340,9 +16571,6 @@ export namespace compute_v1 { * This field is for internal use. This field can be both set at resource creation time and updated using patch. */ privateIpv6GoogleAccess?: string | null; - /** - * 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; /** * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. @@ -17959,9 +18187,6 @@ export namespace compute_v1 { * Network URL. */ network?: string | null; - /** - * 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; /** * The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. @@ -52814,6 +53039,94 @@ export namespace compute_v1 { } } + /** + * Sets the labels on a machine image. 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$Machineimages$Setlabels, + options: StreamMethodOptions + ): GaxiosPromise; + setLabels( + params?: Params$Resource$Machineimages$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Machineimages$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Machineimages$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$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/v1/projects/{project}/global/machineImages/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', '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. * @@ -53014,6 +53327,22 @@ export namespace compute_v1 { */ requestBody?: Schema$GlobalSetPolicyRequest; } + export interface Params$Resource$Machineimages$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } export interface Params$Resource$Machineimages$Testiampermissions extends StandardParameters { /** @@ -85908,205 +86237,577 @@ export namespace compute_v1 { */ project?: string; /** - * Name of the region scoping this request. + * 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$Regionurlmaps$Patch + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to patch. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Update + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to update. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Validate + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the UrlMap resource to be validated as. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionUrlMapsValidateRequest; + } + + export class Resource$Regionzones { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the list of Zone resources under the specific region 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$Regionzones$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regionzones$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionzones$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionzones$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionzones$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionzones$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regionzones$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionzones$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/projects/{project}/regions/{region}/zones' + ).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$Regionzones$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; + /** + * 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/v1/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/v1/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/v1/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 interface Params$Resource$Regionurlmaps$Patch - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; /** - * Name of the region scoping this request. + * Name of the zone for this request. Zone name should conform to RFC1035. */ - region?: string; - /** - * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. - */ - requestId?: string; - /** - * Name of the UrlMap resource to patch. - */ - urlMap?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UrlMap; + zone?: string; } - export interface Params$Resource$Regionurlmaps$Update + export interface Params$Resource$Reservationblocks$Performmaintenance extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. - */ - region?: string; - /** - * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * An optional request ID to identify requests. Specify a unique 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 UrlMap resource to update. + * The name of the reservation. Name should conform to RFC1035 or be a resource ID. */ - urlMap?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UrlMap; - } - export interface Params$Resource$Regionurlmaps$Validate - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; + reservation?: string; /** - * Name of the region scoping this request. + * The name of the reservation block. Name should conform to RFC1035 or be a resource ID. */ - region?: string; + reservationBlock?: string; /** - * Name of the UrlMap resource to be validated as. + * Name of the zone for this request. Zone name should conform to RFC1035. */ - urlMap?: string; + zone?: string; /** * Request body metadata */ - requestBody?: Schema$RegionUrlMapsValidateRequest; - } - - export class Resource$Regionzones { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Retrieves the list of Zone resources under the specific region 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$Regionzones$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Regionzones$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regionzones$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regionzones$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regionzones$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Regionzones$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regionzones$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionzones$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/compute/v1/projects/{project}/regions/{region}/zones' - ).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$Regionzones$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; - /** - * 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; + requestBody?: Schema$ReservationsBlocksPerformMaintenanceRequest; } export class Resource$Reservations { @@ -86648,6 +87349,94 @@ export namespace compute_v1 { } } + /** + * 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/v1/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. * @@ -87146,6 +87935,30 @@ export namespace compute_v1 { */ 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 { /** diff --git a/src/apis/config/v1.ts b/src/apis/config/v1.ts index da9e9a40932..8b5dcaa6999 100644 --- a/src/apis/config/v1.ts +++ b/src/apis/config/v1.ts @@ -1281,6 +1281,10 @@ export namespace config_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index ad5ba98229b..245f929aa2b 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -761,6 +761,10 @@ export namespace connectors_v1 { * Indicate whether cloud spanner is required for connector job. */ provisionCloudSpanner?: boolean | null; + /** + * Indicate whether memstore is required for connector job. + */ + provisionMemstore?: boolean | null; /** * Max QPS supported by the connector version before throttling of requests. */ @@ -831,10 +835,6 @@ export namespace connectors_v1 { * Output only. Eventing configuration supported by the Connector. */ eventingConfigTemplate?: Schema$EventingConfigTemplate; - /** - * Output only. Is async operations supported. - */ - isAsyncOperationsSupported?: boolean | null; /** * Output only. Is custom actions supported. */ @@ -1003,11 +1003,23 @@ export namespace connectors_v1 { */ export interface Schema$CustomConnectorVersion { /** - * Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. + * Optional. Indicates if Async Operations/Connector Job is supported. This is only available for SDK based custom connectors. + */ + asyncOperationsSupport?: boolean | null; + /** + * Optional. Authentication config for accessing connector service (facade). This is used only when enable_backend_destination_config is true. */ authConfig?: Schema$AuthConfig; /** - * Optional. Backend variables config templates. This translates to additional variable templates in connection. + * Optional. Auth Config Templates is only used when connector backend is enabled. This is used to specify the auth configs supported by the connector backend service to talk to the actual application backend. + */ + authConfigTemplates?: Schema$AuthConfigTemplate[]; + /** + * Optional. Auth override support. + */ + authOverrideSupport?: boolean | null; + /** + * Optional. Backend variable templates is only used when connector backend is enabled. This is used to specify the variables required by the connector backend service to talk to the actual application backend. This translates to additional variable templates in the connection config. */ backendVariableTemplates?: Schema$ConfigVariableTemplate[]; /** @@ -1015,11 +1027,11 @@ export namespace connectors_v1 { */ createTime?: string | null; /** - * Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. + * Optional. Destination config(s) for accessing connector service (facade). This is used only when enable_backend_destination_config is true. */ destinationConfigs?: Schema$DestinationConfig[]; /** - * Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation. + * Optional. Indicates if an intermediatory connectorservice is used as backend. When this is enabled, the connector destination and connector auth config are required. For SDK based connectors, this is always enabled. */ enableBackendDestinationConfig?: boolean | null; /** @@ -1043,11 +1055,11 @@ export namespace connectors_v1 { */ serviceAccount?: string | null; /** - * Optional. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///` + * Optional. Location of the custom connector spec. This is only used for Open API based custom connectors. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`. */ specLocation?: string | null; /** - * Output only. Server URLs parsed from the spec. + * Output only. Server URLs parsed from the Open API spec. This is only used for Open API based custom connectors. */ specServerUrls?: string[] | null; /** @@ -1315,7 +1327,7 @@ export namespace connectors_v1 { id?: string | null; } /** - * Eventing Configuration of a connection + * Eventing Configuration of a connection next: 18 */ export interface Schema$EventingConfig { /** @@ -1358,9 +1370,13 @@ export namespace connectors_v1 { * Optional. Registration endpoint for auto registration. */ registrationDestinationConfig?: Schema$DestinationConfig; + /** + * Optional. Ssl config of a connection + */ + sslConfig?: Schema$SslConfig; } /** - * Eventing Config details of a connector version. + * Eventing Config details of a connector version. next: 14 */ export interface Schema$EventingConfigTemplate { /** @@ -1407,6 +1423,10 @@ export namespace connectors_v1 { * Registration host destination config template. */ registrationDestinationConfig?: Schema$DestinationConfigTemplate; + /** + * SSL Config template for the connector version. + */ + sslConfigTemplate?: Schema$SslConfigTemplate; /** * Trigger Config fields that needs to be rendered */ @@ -1788,6 +1808,10 @@ export namespace connectors_v1 { * consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites). */ consumerDefinedName?: string | null; + /** + * Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required. + */ + consumerProjectNumber?: string | null; /** * Output only. Timestamp when the resource was created. */ @@ -2139,6 +2163,10 @@ export namespace connectors_v1 { * Next page token. */ nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; } /** * The response message for Operations.ListOperations. @@ -3350,6 +3378,10 @@ export namespace connectors_v1 { * Specifies if the connector supports action apis like 'executeAction'. */ actionApis?: boolean | null; + /** + * Specifies if the connector supports async long running operations. + */ + asyncOperations?: boolean | null; /** * Specifies if the connector supports entity apis like 'createEntity'. */ @@ -4017,6 +4049,10 @@ export namespace connectors_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -9360,6 +9396,10 @@ export namespace connectors_v1 { * Required. Parent resource of the Managed Zone, of the form: `projects/x/locations/global` */ parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Global$Managedzones$Patch extends StandardParameters { diff --git a/src/apis/connectors/v2.ts b/src/apis/connectors/v2.ts index fa2dcf0f8b8..2a153ae0c58 100644 --- a/src/apis/connectors/v2.ts +++ b/src/apis/connectors/v2.ts @@ -425,6 +425,10 @@ export namespace connectors_v2 { * consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites). */ consumerDefinedName?: string | null; + /** + * Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required. + */ + consumerProjectNumber?: string | null; /** * Output only. Timestamp when the resource was created. */ @@ -1766,6 +1770,10 @@ export namespace connectors_v2 { * Required. Resource name of the Action. Format: projects/{project\}/locations/{location\}/connections/{connection\}/actions/{action\} */ name?: string; + /** + * Specified view of the action schema. + */ + view?: string; } export interface Params$Resource$Projects$Locations$Connections$Actions$List extends StandardParameters { diff --git a/src/apis/contactcenteraiplatform/v1alpha1.ts b/src/apis/contactcenteraiplatform/v1alpha1.ts index c7167f86e01..4dca1dfec41 100644 --- a/src/apis/contactcenteraiplatform/v1alpha1.ts +++ b/src/apis/contactcenteraiplatform/v1alpha1.ts @@ -162,6 +162,10 @@ export namespace contactcenteraiplatform_v1alpha1 { * Optional. Info about the first admin user, such as given name and family name. */ adminUser?: Schema$AdminUser; + /** + * Optional. Whether the advanced reporting feature is enabled. + */ + advancedReportingEnabled?: boolean | null; /** * Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity */ @@ -909,6 +913,10 @@ export namespace contactcenteraiplatform_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index b9589bd9f1a..919021d698f 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -1363,7 +1363,7 @@ export namespace contactcenterinsights_v1 { source?: string | null; } /** - * 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. + * 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. AgentAssistSummary labels are used for Agent Assist Summarization. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel { /** @@ -1375,7 +1375,7 @@ export namespace contactcenterinsights_v1 { */ label?: string | null; /** - * Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard\}/revisions/{revision\}/qaQuestions/{question\} - issueModels/{issue_model\} + * Name of the resource to be labeled. Supported resources are: * `projects/{project\}/locations/{location\}/qaScorecards/{scorecard\}/revisions/{revision\}/qaQuestions/{question\}` * `projects/{project\}/locations/{location\}/issueModels/{issue_model\}` * `projects/{project\}/locations/{location\}/generators/{generator_id\}` */ labeledResource?: string | null; /** @@ -2158,6 +2158,19 @@ export namespace contactcenterinsights_v1 { */ dataPoints?: Schema$GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint[]; } + /** + * The metadata for querying performance overview. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata {} + /** + * The response for querying performance overview. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse { + /** + * The summary text of the performance. + */ + summaryText?: string | null; + } /** * DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. */ @@ -2875,6 +2888,10 @@ export namespace contactcenterinsights_v1 { * Required. The parent resource for new feedback labels. */ parent?: string | null; + /** + * A sheets document destination. + */ + sheetsDestination?: Schema$GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination; /** * Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored. */ @@ -2905,6 +2922,19 @@ export namespace contactcenterinsights_v1 { */ recordsPerFileCount?: string | null; } + /** + * Google Sheets document details to write the feedback labels to. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination { + /** + * Optional. The title of the new sheet to write the feedback labels to. + */ + sheetTitle?: string | null; + /** + * Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata. + */ + spreadsheetUri?: string | null; + } /** * Response for the BulkDownloadFeedbackLabel endpoint. */ @@ -2917,6 +2947,10 @@ export namespace contactcenterinsights_v1 { * A cloud storage bucket source. */ gcsSource?: Schema$GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource; + /** + * A sheets document source. + */ + sheetsSource?: Schema$GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource; /** * Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete. */ @@ -2935,6 +2969,15 @@ export namespace contactcenterinsights_v1 { */ objectUri?: string | null; } + /** + * Google Sheets document details to get the feedback label file from. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource { + /** + * Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. + */ + spreadsheetUri?: string | null; + } /** * Response of querying an issue model's statistics. */ @@ -3884,7 +3927,7 @@ export namespace contactcenterinsights_v1 { source?: string | null; } /** - * 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. + * 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. AgentAssistSummary labels are used for Agent Assist Summarization. */ export interface Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel { /** @@ -3896,7 +3939,7 @@ export namespace contactcenterinsights_v1 { */ label?: string | null; /** - * Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard\}/revisions/{revision\}/qaQuestions/{question\} - issueModels/{issue_model\} + * Name of the resource to be labeled. Supported resources are: * `projects/{project\}/locations/{location\}/qaScorecards/{scorecard\}/revisions/{revision\}/qaQuestions/{question\}` * `projects/{project\}/locations/{location\}/issueModels/{issue_model\}` * `projects/{project\}/locations/{location\}/generators/{generator_id\}` */ labeledResource?: string | null; /** @@ -5064,6 +5107,19 @@ export namespace contactcenterinsights_v1 { */ dataPoints?: Schema$GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint[]; } + /** + * The metadata for querying performance overview. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata {} + /** + * The response for querying performance overview. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse { + /** + * The summary text of the performance. + */ + summaryText?: string | null; + } /** * DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. */ @@ -5482,6 +5538,7 @@ export namespace contactcenterinsights_v1 { analysisRules: Resource$Projects$Locations$Analysisrules; authorizedViewSets: Resource$Projects$Locations$Authorizedviewsets; conversations: Resource$Projects$Locations$Conversations; + datasets: Resource$Projects$Locations$Datasets; encryptionSpec: Resource$Projects$Locations$Encryptionspec; insightsdata: Resource$Projects$Locations$Insightsdata; issueModels: Resource$Projects$Locations$Issuemodels; @@ -5499,6 +5556,7 @@ export namespace contactcenterinsights_v1 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.datasets = new Resource$Projects$Locations$Datasets(this.context); this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( this.context ); @@ -6944,12 +7002,17 @@ export namespace contactcenterinsights_v1 { export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews { context: APIRequestContext; conversations: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations; + operations: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations; constructor(context: APIRequestContext) { this.context = context; this.conversations = new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations( this.context ); + this.operations = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations( + this.context + ); } /** @@ -7065,8 +7128,115 @@ export namespace contactcenterinsights_v1 { export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations { context: APIRequestContext; + analyses: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses; + feedbackLabels: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels; constructor(context: APIRequestContext) { this.context = context; + this.analyses = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses( + this.context + ); + this.feedbackLabels = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels( + this.context + ); + } + + /** + * Analyzes multiple conversations in a single 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. + */ + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + options: StreamMethodOptions + ): GaxiosPromise; + bulkAnalyze( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + options?: MethodOptions + ): GaxiosPromise; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + callback: BodyResponseCallback + ): void; + bulkAnalyze( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; + 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}/conversations:bulkAnalyze').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); + } } /** @@ -7166,95 +7336,63 @@ export namespace contactcenterinsights_v1 { ); } } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. - */ - filter?: string; - /** - * Required. The location of the conversations. - */ - location?: string; - } - - export class Resource$Projects$Locations$Conversations { - context: APIRequestContext; - analyses: Resource$Projects$Locations$Conversations$Analyses; - feedbackLabels: Resource$Projects$Locations$Conversations$Feedbacklabels; - constructor(context: APIRequestContext) { - this.context = context; - this.analyses = new Resource$Projects$Locations$Conversations$Analyses( - this.context - ); - this.feedbackLabels = - new Resource$Projects$Locations$Conversations$Feedbacklabels( - this.context - ); - } /** - * Analyzes multiple conversations in a single request. + * Deletes 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. */ - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - bulkAnalyze( - params?: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + delete( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkAnalyze( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, + callback: BodyResponseCallback ): void; - bulkAnalyze( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Bulkanalyze - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Conversations$Bulkanalyze; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete; options = {}; } @@ -7268,90 +7406,87 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes multiple conversations in a single request. + * 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. */ - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - bulkDelete( - params?: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, + callback: BodyResponseCallback ): void; - bulkDelete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - bulkDelete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Bulkdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Conversations$Bulkdelete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get; options = {}; } @@ -7365,90 +7500,89 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets conversation statistics. + * Lists conversations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - calculateStats( - params?: Params$Resource$Projects$Locations$Conversations$Calculatestats, + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, + callback: BodyResponseCallback ): void; - calculateStats( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - calculateStats( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Calculatestats - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Conversations$Calculatestats; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Calculatestats; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List; options = {}; } @@ -7462,33 +7596,114 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+location}/conversations:calculateStats' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze + extends StandardParameters { /** - * Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead. + * Required. The parent resource to create analyses in. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. + */ + filter?: string; + /** + * Required. The location of the conversations. + */ + location?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete + extends StandardParameters { + /** + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get + extends StandardParameters { + /** + * Required. The name of the conversation to get. + */ + name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + */ + orderBy?: string; + /** + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; + } + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an analysis. The long running operation is done when the analysis has completed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7496,56 +7711,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Conversations$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Conversations$Create, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Conversations$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$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$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Create; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; options = {}; } @@ -7559,7 +7775,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+parent}/analyses').replace( /([^:]\/)\/+/g, '$1' ), @@ -7574,19 +7790,17 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a conversation. + * Deletes an analysis. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7594,31 +7808,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Conversations$Delete, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Delete + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7634,12 +7848,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Delete; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; options = {}; } @@ -7675,7 +7890,7 @@ export namespace contactcenterinsights_v1 { } /** - * Gets a conversation. + * Gets an analysis. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7683,56 +7898,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Conversations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Conversations$Get, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Conversations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$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$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Get; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; options = {}; } @@ -7758,76 +7974,77 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Imports conversations and processes them according to the user's configuration. + * Lists analyses. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, options: StreamMethodOptions ): GaxiosPromise; - ingest( - params?: Params$Resource$Projects$Locations$Conversations$Ingest, + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, options?: MethodOptions - ): GaxiosPromise; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + callback: BodyResponseCallback ): void; - ingest( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - ingest( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Ingest - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$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$Conversations$Ingest; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Ingest; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; options = {}; } @@ -7841,11 +8058,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + url: (rootUrl + '/v1/{+parent}/analyses').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -7856,74 +8073,130 @@ export namespace contactcenterinsights_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$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create + extends StandardParameters { /** - * Lists conversations. + * Required. The parent resource of the analysis. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete + extends StandardParameters { + /** + * Required. The name of the analysis to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get + extends StandardParameters { + /** + * Required. The name of the analysis to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the analyses. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Conversations$List, + create( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Conversations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$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$Conversations$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$List; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; options = {}; } @@ -7937,11 +8210,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -7952,76 +8225,73 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a conversation. + * Delete feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Conversations$Patch, + delete( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$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$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Patch; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; options = {}; } @@ -8036,7 +8306,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -8047,76 +8317,75 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. + * Get feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: StreamMethodOptions ): GaxiosPromise; - upload( - params?: Params$Resource$Projects$Locations$Conversations$Upload, + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - upload( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Upload - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$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$Conversations$Upload; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Upload; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; options = {}; } @@ -8130,180 +8399,2174 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:upload').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Conversations$Bulkanalyze - extends StandardParameters { - /** - * Required. The parent resource to create analyses in. - */ - parent?: string; /** - * Request body metadata + * List feedback labels. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Bulkdelete + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; + 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}/feedbackLabels').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 feedback label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: '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$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create extends StandardParameters { /** - * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} + * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. + */ + feedbackLabelId?: string; + /** + * Required. The parent resource of the feedback label. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; } - export interface Params$Resource$Projects$Locations$Conversations$Calculatestats + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete extends StandardParameters { /** - * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. - */ - filter?: string; - /** - * Required. The location of the conversations. + * Required. The name of the feedback label to delete. */ - location?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Create + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get extends StandardParameters { /** - * A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` + * Required. The name of the feedback label to get. */ - conversationId?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List + extends StandardParameters { /** - * Required. The parent resource of the conversation. + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. 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 */ - parent?: string; - + filter?: string; /** - * Request body metadata + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; - } - export interface Params$Resource$Projects$Locations$Conversations$Delete - extends StandardParameters { + pageSize?: number; /** - * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. */ - force?: boolean; + pageToken?: string; /** - * Required. The name of the conversation to delete. + * Required. The parent resource of the feedback labels. */ - name?: string; + parent?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Get + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch extends StandardParameters { /** - * Required. The name of the conversation to get. + * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} */ name?: string; /** - * The level of details of the conversation. Default is `FULL`. + * Required. The list of fields to be updated. */ - view?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; } - export interface Params$Resource$Projects$Locations$Conversations$Ingest + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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$Authorizedviewsets$Authorizedviews$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/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$Authorizedviewsets$Authorizedviews$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Conversations { + context: APIRequestContext; + analyses: Resource$Projects$Locations$Conversations$Analyses; + feedbackLabels: Resource$Projects$Locations$Conversations$Feedbacklabels; + constructor(context: APIRequestContext) { + this.context = context; + this.analyses = new Resource$Projects$Locations$Conversations$Analyses( + this.context + ); + this.feedbackLabels = + new Resource$Projects$Locations$Conversations$Feedbacklabels( + this.context + ); + } + + /** + * Analyzes multiple conversations in a single 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. + */ + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options: StreamMethodOptions + ): GaxiosPromise; + bulkAnalyze( + params?: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options?: MethodOptions + ): GaxiosPromise; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + callback: BodyResponseCallback + ): void; + bulkAnalyze( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Bulkanalyze + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + 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}/conversations:bulkAnalyze').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 multiple conversations in a single 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. + */ + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options: StreamMethodOptions + ): GaxiosPromise; + bulkDelete( + params?: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options?: MethodOptions + ): GaxiosPromise; + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + callback: BodyResponseCallback + ): void; + bulkDelete( + callback: BodyResponseCallback + ): void; + bulkDelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Bulkdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + 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}/conversations:bulkDelete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets conversation statistics. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options: StreamMethodOptions + ): GaxiosPromise; + calculateStats( + params?: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options?: MethodOptions + ): GaxiosPromise; + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + callback: BodyResponseCallback + ): void; + calculateStats( + callback: BodyResponseCallback + ): void; + calculateStats( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Calculatestats + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Calculatestats; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Calculatestats; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+location}/conversations:calculateStats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Conversations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Create; + 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}/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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Conversations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: '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$Conversations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Conversations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Imports conversations and processes them according to the user's configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + options: StreamMethodOptions + ): GaxiosPromise; + ingest( + params?: Params$Resource$Projects$Locations$Conversations$Ingest, + options?: MethodOptions + ): GaxiosPromise; + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + callback: BodyResponseCallback + ): void; + ingest( + callback: BodyResponseCallback + ): void; + ingest( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Ingest + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Ingest; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Ingest; + 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}/conversations:ingest').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 conversations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Conversations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Conversations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$List; + 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}/conversations').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 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. + */ + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Conversations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Projects$Locations$Conversations$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Projects$Locations$Conversations$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Upload; + 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}/conversations:upload').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$Conversations$Bulkanalyze + extends StandardParameters { + /** + * Required. The parent resource to create analyses in. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Bulkdelete + extends StandardParameters { + /** + * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Calculatestats + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. + */ + filter?: string; + /** + * Required. The location of the conversations. + */ + location?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Create + extends StandardParameters { + /** + * A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` + */ + conversationId?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; + } + export interface Params$Resource$Projects$Locations$Conversations$Delete + extends StandardParameters { + /** + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Get + extends StandardParameters { + /** + * Required. The name of the conversation to get. + */ + name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Ingest + extends StandardParameters { + /** + * Required. The parent resource for new conversations. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + */ + orderBy?: string; + /** + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} + */ + name?: string; + /** + * The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; + } + export interface Params$Resource$Projects$Locations$Conversations$Upload + extends StandardParameters { + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1UploadConversationRequest; + } + + export class Resource$Projects$Locations$Conversations$Analyses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an analysis. The long running operation is done when the analysis has completed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Analyses$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Create; + 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}/analyses').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 analysis. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Analyses$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an analysis. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Analyses$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists analyses. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Analyses$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$List; + 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}/analyses').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$Conversations$Analyses$Create extends StandardParameters { /** - * Required. The parent resource for new conversations. + * Required. The parent resource of the analysis. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; } - export interface Params$Resource$Projects$Locations$Conversations$List + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Delete extends StandardParameters { /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - */ - filter?: string; - /** - * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). - */ - orderBy?: string; - /** - * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the conversation. - */ - parent?: string; - /** - * The level of details of the conversation. Default is `BASIC`. + * Required. The name of the analysis to delete. */ - view?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Patch + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Get extends StandardParameters { /** - * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} + * Required. The name of the analysis to get. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Analyses$List + extends StandardParameters { /** - * The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri` + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. */ - updateMask?: string; - + filter?: string; /** - * Request body metadata + * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; - } - export interface Params$Resource$Projects$Locations$Conversations$Upload - extends StandardParameters { + pageSize?: number; /** - * Required. The parent resource of the conversation. + * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. */ - parent?: string; - + pageToken?: string; /** - * Request body metadata + * Required. The parent resource of the analyses. */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1UploadConversationRequest; + parent?: string; } - export class Resource$Projects$Locations$Conversations$Analyses { + export class Resource$Projects$Locations$Conversations$Feedbacklabels { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates an analysis. The long running operation is done when the analysis has completed. + * Create feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8311,57 +10574,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$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$Conversations$Analyses$Create; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Create; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; options = {}; } @@ -8375,7 +10638,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), @@ -8390,17 +10653,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an analysis. + * Delete feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8408,31 +10673,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Delete + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8448,13 +10713,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; options = {}; } @@ -8490,7 +10755,7 @@ export namespace contactcenterinsights_v1 { } /** - * Gets an analysis. + * Get feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8498,57 +10763,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$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$Conversations$Analyses$Get; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Get; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; options = {}; } @@ -8574,77 +10839,176 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List feedback labels. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Feedbacklabels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + 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}/feedbackLabels').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( + return createAPIRequest( parameters ); } } /** - * Lists analyses. + * Update feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$List, + patch( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$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$Conversations$Analyses$List; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$List; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; options = {}; } @@ -8658,145 +11022,172 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + 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$Conversations$Analyses$Create + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create extends StandardParameters { /** - * Required. The parent resource of the analysis. + * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. + */ + feedbackLabelId?: string; + /** + * Required. The parent resource of the feedback label. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Delete + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete extends StandardParameters { /** - * Required. The name of the analysis to delete. + * Required. The name of the feedback label to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Get + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get extends StandardParameters { /** - * Required. The name of the analysis to get. + * Required. The name of the feedback label to get. */ name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$List + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List extends StandardParameters { /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. 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; /** - * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ pageSize?: number; /** - * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the analyses. + * Required. The parent resource of the feedback labels. */ parent?: string; } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} + */ + name?: string; + /** + * Required. The list of fields to be updated. + */ + updateMask?: string; - export class Resource$Projects$Locations$Conversations$Feedbacklabels { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + + export class Resource$Projects$Locations$Datasets { + context: APIRequestContext; + conversations: Resource$Projects$Locations$Datasets$Conversations; + insightsdata: Resource$Projects$Locations$Datasets$Insightsdata; + constructor(context: APIRequestContext) { + this.context = context; + this.conversations = + new Resource$Projects$Locations$Datasets$Conversations(this.context); + this.insightsdata = new Resource$Projects$Locations$Datasets$Insightsdata( + this.context + ); + } + } + + export class Resource$Projects$Locations$Datasets$Conversations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create feedback label. + * Deletes 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. */ - create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$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$Conversations$Feedbacklabels$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; options = {}; } @@ -8810,88 +11201,87 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').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); } } /** - * Delete feedback label. + * 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. */ - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + get( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$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$Conversations$Feedbacklabels$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Get; options = {}; } @@ -8906,7 +11296,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -8917,75 +11307,77 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Get feedback label. + * Imports conversations and processes them according to the user's configuration. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + ingest( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + ): GaxiosPromise; + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, - callback: BodyResponseCallback + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + ingest( + callback: BodyResponseCallback ): void; - get( + ingest( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; options = {}; } @@ -8999,31 +11391,32 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/conversations:ingest').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); } } /** - * List feedback labels. + * Lists conversations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9031,57 +11424,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + params?: Params$Resource$Projects$Locations$Datasets$Conversations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$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$Conversations$Feedbacklabels$List; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$List; options = {}; } @@ -9095,7 +11488,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + url: (rootUrl + '/v1/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -9110,77 +11503,146 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Delete + extends StandardParameters { /** - * Update feedback label. + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Get + extends StandardParameters { + /** + * Required. The name of the conversation to get. + */ + name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + extends StandardParameters { + /** + * Required. The parent resource for new conversations. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + */ + orderBy?: string; + /** + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; + } + + export class Resource$Projects$Locations$Datasets$Insightsdata { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Export insights data to a destination defined in the request body. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Conversations$Feedbacklabels$Patch, + export( + params: Params$Resource$Projects$Locations$Datasets$Insightsdata$Export, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + export( + params?: Params$Resource$Projects$Locations$Datasets$Insightsdata$Export, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Datasets$Insightsdata$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + export( + params: Params$Resource$Projects$Locations$Datasets$Insightsdata$Export, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, - callback: BodyResponseCallback + export( + params: Params$Resource$Projects$Locations$Datasets$Insightsdata$Export, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + export( + callback: BodyResponseCallback ): void; - patch( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Insightsdata$Export + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Insightsdata$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; + {} as Params$Resource$Projects$Locations$Datasets$Insightsdata$Export; options = {}; } @@ -9194,94 +11656,42 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/insightsdata:export').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$Conversations$Feedbacklabels$Create - extends StandardParameters { - /** - * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. - */ - feedbackLabelId?: string; - /** - * Required. The parent resource of the feedback label. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete - extends StandardParameters { - /** - * Required. The name of the feedback label to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get - extends StandardParameters { - /** - * Required. The name of the feedback label to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List + export interface Params$Resource$Projects$Locations$Datasets$Insightsdata$Export extends StandardParameters { /** - * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. 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; - /** - * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the feedback labels. + * Required. The parent resource to export data from. */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch - extends StandardParameters { - /** - * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} - */ - name?: string; - /** - * Required. The list of fields to be updated. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest; } export class Resource$Projects$Locations$Encryptionspec { diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 323e5b05e50..5f465ec20b4 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -381,7 +381,7 @@ export namespace container_v1 { */ imageType?: string | null; /** - * Enable or disable Kubelet read only port. + * DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. */ insecureKubeletReadonlyPortEnabled?: boolean | null; /** @@ -717,6 +717,9 @@ 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. @@ -751,7 +754,7 @@ export namespace container_v1 { */ monitoringConfig?: Schema$MonitoringConfig; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + * The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. */ monitoringService?: string | null; /** @@ -798,6 +801,10 @@ export namespace container_v1 { * The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster. */ parentProductConfig?: Schema$ParentProductConfig; + /** + * The config for pod autoscaling. + */ + podAutoscaling?: Schema$PodAutoscaling; /** * Configuration for private cluster. */ @@ -1066,7 +1073,7 @@ export namespace container_v1 { */ desiredMonitoringConfig?: Schema$MonitoringConfig; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + * The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. */ desiredMonitoringService?: string | null; /** @@ -1117,6 +1124,10 @@ export namespace container_v1 { * The desired parent product config for the cluster. */ desiredParentProductConfig?: Schema$ParentProductConfig; + /** + * The desired config for pod autoscaling. + */ + desiredPodAutoscaling?: Schema$PodAutoscaling; /** * The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field. See also ClusterUpdate.desired_enable_private_endpoint for modifying other fields within PrivateClusterConfig. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.global_access instead. */ @@ -1182,6 +1193,39 @@ export namespace container_v1 { */ userManagedKeysConfig?: Schema$UserManagedKeysConfig; } + /** + * ClusterUpgradeInfo contains the upgrade information of a cluster. + */ + export interface Schema$ClusterUpgradeInfo { + /** + * The auto upgrade status. + */ + autoUpgradeStatus?: string[] | null; + /** + * The cluster's current minor version's end of extended support timestamp. + */ + endOfExtendedSupportTimestamp?: string | null; + /** + * The cluster's current minor version's end of standard support timestamp. + */ + endOfStandardSupportTimestamp?: string | null; + /** + * minor_target_version indicates the target version for minor upgrade. + */ + minorTargetVersion?: string | null; + /** + * patch_target_version indicates the target version for patch upgrade. + */ + patchTargetVersion?: string | null; + /** + * The auto upgrade paused reason. + */ + pausedReason?: string[] | null; + /** + * The list of past auto upgrades. + */ + upgradeDetails?: Schema$UpgradeDetails[]; + } /** * CompleteIPRotationRequest moves the cluster master back into single-IP mode. */ @@ -1233,6 +1277,10 @@ export namespace container_v1 { * ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. */ export interface Schema$ConfidentialNodes { + /** + * Defines the type of technology used by the confidential node. + */ + confidentialInstanceType?: string | null; /** * Whether Confidential Nodes feature is enabled. */ @@ -1453,6 +1501,10 @@ export namespace container_v1 { * EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. */ export interface Schema$EphemeralStorageLocalSsdConfig { + /** + * Number of local SSDs to use for GKE Data Cache. + */ + dataCacheCount?: number | null; /** * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ @@ -2335,6 +2387,10 @@ export namespace container_v1 { * Enable or disable NCCL fast socket for the node pool. */ fastSocket?: Schema$FastSocket; + /** + * Flex Start flag for enabling Flex Start VM. + */ + flexStart?: boolean | null; /** * Google Container File System (image streaming) configs. */ @@ -2610,7 +2666,7 @@ export namespace container_v1 { */ 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 + * Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. */ autopilotConfig?: Schema$AutopilotConfig; /** @@ -2770,6 +2826,39 @@ export namespace container_v1 { */ variantConfig?: Schema$LoggingVariantConfig; } + /** + * NodePoolUpgradeInfo contains the upgrade information of a nodepool. + */ + export interface Schema$NodePoolUpgradeInfo { + /** + * The auto upgrade status. + */ + autoUpgradeStatus?: string[] | null; + /** + * The nodepool's current minor version's end of extended support timestamp. + */ + endOfExtendedSupportTimestamp?: string | null; + /** + * The nodepool's current minor version's end of standard support timestamp. + */ + endOfStandardSupportTimestamp?: string | null; + /** + * minor_target_version indicates the target version for minor upgrade. + */ + minorTargetVersion?: string | null; + /** + * patch_target_version indicates the target version for patch upgrade. + */ + patchTargetVersion?: string | null; + /** + * The auto upgrade paused reason. + */ + pausedReason?: string[] | null; + /** + * The list of past auto upgrades. + */ + upgradeDetails?: Schema$UpgradeDetails[]; + } /** * Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values. */ @@ -2947,6 +3036,15 @@ export namespace container_v1 { */ type?: string | null; } + /** + * PodAutoscaling is used for configuration of parameters for workload autoscaling. + */ + export interface Schema$PodAutoscaling { + /** + * Selected Horizontal Pod Autoscaling profile. + */ + hpaProfile?: string | null; + } /** * [PRIVATE FIELD] Config for pod CIDR size overprovisioning. */ @@ -3306,6 +3404,10 @@ export namespace container_v1 { * If this field is specified, it means there are manual steps that the user must take to make their clusters safe. */ manualStepsRequired?: boolean | null; + /** + * The GKE versions where this vulnerability is mitigated. + */ + mitigatedVersions?: string[] | null; /** * The GKE versions where this vulnerability is patched. */ @@ -3566,7 +3668,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * Required. The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + * Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. */ monitoringService?: string | null; /** @@ -3922,6 +4024,10 @@ export namespace container_v1 { * Enable or disable NCCL fast socket for the node pool. */ fastSocket?: Schema$FastSocket; + /** + * Flex Start flag for enabling Flex Start VM. + */ + flexStart?: boolean | null; /** * GCFS config. */ @@ -4044,6 +4150,35 @@ export namespace container_v1 { */ version?: string | null; } + /** + * UpgradeDetails contains detailed information of each individual upgrade operation. + */ + export interface Schema$UpgradeDetails { + /** + * The end timestamp of the upgrade. + */ + endTime?: string | null; + /** + * The version before the upgrade. + */ + initialVersion?: string | null; + /** + * The start timestamp of the upgrade. + */ + startTime?: string | null; + /** + * The start type of the upgrade. + */ + startType?: string | null; + /** + * Output only. The state of the upgrade. + */ + state?: string | null; + /** + * The version after the upgrade. + */ + targetVersion?: string | null; + } /** * UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading. */ @@ -4245,11 +4380,11 @@ export namespace container_v1 { enabled?: boolean | null; } /** - * Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings + * Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings. */ export interface Schema$WindowsNodeConfig { /** - * OSVersion specifies the Windows node config to be used on the node + * OSVersion specifies the Windows node config to be used on the node. */ osVersion?: string | null; } @@ -4923,6 +5058,100 @@ export namespace container_v1 { } } + /** + * Fetch upgrade information of a specific 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. + */ + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo, + options: StreamMethodOptions + ): GaxiosPromise; + fetchClusterUpgradeInfo( + params?: Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo, + options?: MethodOptions + ): GaxiosPromise; + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo, + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://container.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchClusterUpgradeInfo').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 details of a specific cluster. * @@ -6306,6 +6535,17 @@ export namespace container_v1 { */ zone?: string; } + export interface Params$Resource$Projects$Locations$Clusters$Fetchclusterupgradeinfo + extends StandardParameters { + /** + * Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/x/locations/x/clusters/x` or `projects/x/zones/x/clusters/x`. + */ + name?: string; + /** + * API request version that initiates this operation. + */ + version?: string; + } export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters { /** @@ -6762,6 +7002,100 @@ export namespace container_v1 { } } + /** + * Fetch upgrade information of a specific nodepool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options: StreamMethodOptions + ): GaxiosPromise; + fetchNodePoolUpgradeInfo( + params?: Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options?: MethodOptions + ): GaxiosPromise; + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://container.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchNodePoolUpgradeInfo').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); + } + } + /** * Retrieves the requested node pool. * @@ -7432,6 +7766,17 @@ export namespace container_v1 { */ zone?: string; } + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Fetchnodepoolupgradeinfo + extends StandardParameters { + /** + * Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/x/locations/x/clusters/x/nodePools/x` or `projects/x/zones/x/clusters/x/nodePools/x`. + */ + name?: string; + /** + * API request version that initiates this operation. + */ + version?: string; + } export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Get extends StandardParameters { /** @@ -8438,6 +8783,100 @@ export namespace container_v1 { } } + /** + * Fetch upgrade information of a specific 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. + */ + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo, + options: StreamMethodOptions + ): GaxiosPromise; + fetchClusterUpgradeInfo( + params?: Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo, + options?: MethodOptions + ): GaxiosPromise; + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo, + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + callback: BodyResponseCallback + ): void; + fetchClusterUpgradeInfo( + paramsOrCallback?: + | Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://container.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchClusterUpgradeInfo').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 details of a specific cluster. * @@ -9665,6 +10104,17 @@ export namespace container_v1 { */ zone?: string; } + export interface Params$Resource$Projects$Zones$Clusters$Fetchclusterupgradeinfo + extends StandardParameters { + /** + * Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/x/locations/x/clusters/x` or `projects/x/zones/x/clusters/x`. + */ + name?: string; + /** + * API request version that initiates this operation. + */ + version?: string; + } export interface Params$Resource$Projects$Zones$Clusters$Get extends StandardParameters { /** @@ -10191,6 +10641,100 @@ export namespace container_v1 { } } + /** + * Fetch upgrade information of a specific nodepool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options: StreamMethodOptions + ): GaxiosPromise; + fetchNodePoolUpgradeInfo( + params?: Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options?: MethodOptions + ): GaxiosPromise; + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + params: Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo, + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + callback: BodyResponseCallback + ): void; + fetchNodePoolUpgradeInfo( + paramsOrCallback?: + | Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://container.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchNodePoolUpgradeInfo').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); + } + } + /** * Retrieves the requested node pool. * @@ -10795,6 +11339,17 @@ export namespace container_v1 { */ zone?: string; } + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Fetchnodepoolupgradeinfo + extends StandardParameters { + /** + * Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/x/locations/x/clusters/x/nodePools/x` or `projects/x/zones/x/clusters/x/nodePools/x`. + */ + name?: string; + /** + * API request version that initiates this operation. + */ + version?: string; + } export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Get extends StandardParameters { /** diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 5f67986c065..4cd903cf026 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -406,7 +406,7 @@ export namespace container_v1beta1 { */ imageType?: string | null; /** - * Enable or disable Kubelet read only port. + * DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. */ insecureKubeletReadonlyPortEnabled?: boolean | null; /** @@ -816,7 +816,7 @@ export namespace container_v1beta1 { */ monitoringConfig?: Schema$MonitoringConfig; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + * The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. */ monitoringService?: string | null; /** @@ -1180,7 +1180,7 @@ export namespace container_v1beta1 { */ desiredMonitoringConfig?: Schema$MonitoringConfig; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + * The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. */ desiredMonitoringService?: string | null; /** @@ -1408,6 +1408,10 @@ export namespace container_v1beta1 { * ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. */ export interface Schema$ConfidentialNodes { + /** + * Defines the type of technology used by the confidential node. + */ + confidentialInstanceType?: string | null; /** * Whether Confidential Nodes feature is enabled. */ @@ -1654,6 +1658,10 @@ export namespace container_v1beta1 { * EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. */ export interface Schema$EphemeralStorageLocalSsdConfig { + /** + * Number of local SSDs to use for GKE Data Cache. + */ + dataCacheCount?: number | null; /** * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ @@ -2590,7 +2598,7 @@ export namespace container_v1beta1 { */ containerdConfig?: Schema$ContainerdConfig; /** - * Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. + * Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. TODO(b/395671893) - Deprecate disk_size_gb and disk_type fields. If unspecified, the default disk size is 100GB. */ diskSizeGb?: number | null; /** @@ -2617,6 +2625,10 @@ export namespace container_v1beta1 { * Enable or disable NCCL fast socket for the node pool. */ fastSocket?: Schema$FastSocket; + /** + * Flex Start flag for enabling Flex Start VM. + */ + flexStart?: boolean | null; /** * GCFS (Google Container File System) configs. */ @@ -2900,7 +2912,7 @@ export namespace container_v1beta1 { */ 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 + * Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. */ autopilotConfig?: Schema$AutopilotConfig; /** @@ -3627,6 +3639,19 @@ export namespace container_v1beta1 { */ zone?: string | null; } + /** + * RotationConfig is config for secret manager auto rotation. + */ + export interface Schema$RotationConfig { + /** + * Whether the rotation is enabled. + */ + enabled?: boolean | null; + /** + * The interval between two consecutive rotations. Default rotation interval is 2 minutes. + */ + rotationInterval?: string | null; + } /** * SandboxConfig contains configurations of the sandbox to use for the node. */ @@ -3665,6 +3690,10 @@ export namespace container_v1beta1 { * Enable/Disable Secret Manager Config. */ enabled?: boolean | null; + /** + * Rotation config for secret manager. + */ + rotationConfig?: Schema$RotationConfig; } /** * SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to. @@ -3694,6 +3723,10 @@ export namespace container_v1beta1 { * If this field is specified, it means there are manual steps that the user must take to make their clusters safe. */ manualStepsRequired?: boolean | null; + /** + * The GKE versions where this vulnerability is mitigated. + */ + mitigatedVersions?: string[] | null; /** * The GKE versions where this vulnerability is patched. */ @@ -3958,7 +3991,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * Required. The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + * Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. */ monitoringService?: string | null; /** @@ -4331,6 +4364,10 @@ export namespace container_v1beta1 { * Enable or disable NCCL fast socket for the node pool. */ fastSocket?: Schema$FastSocket; + /** + * Flex Start flag for enabling Flex Start VM. + */ + flexStart?: boolean | null; /** * GCFS config. */ @@ -4473,6 +4510,10 @@ export namespace container_v1beta1 { * The start timestamp of the upgrade. */ startTime?: string | null; + /** + * The start type of the upgrade. + */ + startType?: string | null; /** * Output only. The state of the upgrade. */ @@ -4683,11 +4724,11 @@ export namespace container_v1beta1 { enabled?: boolean | null; } /** - * Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings + * Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings. */ export interface Schema$WindowsNodeConfig { /** - * OSVersion specifies the Windows node config to be used on the node + * OSVersion specifies the Windows node config to be used on the node. */ osVersion?: string | null; } diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index a7854efb554..75e505aa608 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -745,7 +745,7 @@ export namespace containeranalysis_v1 { */ groupId?: string | null; /** - * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + * Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. */ path?: string | null; /** diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 797025a20a1..0515919b433 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -725,7 +725,7 @@ export namespace containeranalysis_v1alpha1 { */ groupId?: string | null; /** - * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + * Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. */ path?: string | null; /** @@ -3622,7 +3622,7 @@ export namespace containeranalysis_v1alpha1 { */ 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 + * "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/v1/digest_set.md. */ digest?: {[key: string]: string} | null; /** diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 61b29e75101..5005ffc19e7 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -652,7 +652,7 @@ export namespace containeranalysis_v1beta1 { */ groupId?: string | null; /** - * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + * Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. */ path?: string | null; /** diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 5314c0bd638..8a30b655e9b 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -4213,7 +4213,7 @@ export namespace content_v2_1 { suggestedPriceMicros?: string | null; } /** - * Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. + * Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. */ export interface Schema$Product { /** @@ -14136,7 +14136,7 @@ export namespace content_v2_1 { } /** - * Sets the inventory verification contract for the specified country. + * Sets the inventory verification contact for the specified country. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/css/v1.ts b/src/apis/css/v1.ts index 9e299ac4b8b..7f2cad8fc2e 100644 --- a/src/apis/css/v1.ts +++ b/src/apis/css/v1.ts @@ -186,7 +186,7 @@ export namespace css_v1 { */ labelType?: string | null; /** - * The resource name of the label. Format: accounts/{account\}/labels/{label\} + * Identifier. The resource name of the label. Format: accounts/{account\}/labels/{label\} */ name?: 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\}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 + * Identifier. 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; /** @@ -663,6 +663,40 @@ export namespace css_v1 { */ nextPageToken?: string | null; } + /** + * Response message for the ListMethodGroups method. + */ + export interface Schema$ListQuotaGroupsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quota_usage. + */ + quotaGroups?: Schema$QuotaGroup[]; + } + /** + * The method details per method in the CSS API. + */ + export interface Schema$MethodDetails { + /** + * Output only. The name of the method for example `cssproductsservice.listcssproducts`. + */ + method?: string | null; + /** + * Output only. The path for the method such as `v1/cssproductsservice.listcssproducts`. + */ + path?: string | null; + /** + * Output only. The sub-API that the method belongs to. In the CSS API, this is always `css`. + */ + subapi?: string | null; + /** + * Output only. The API version that the method belongs to. + */ + version?: string | null; + } /** * The price represented as a number and currency. */ @@ -719,6 +753,31 @@ export namespace css_v1 { */ value?: number | null; } + /** + * The group information for methods in the CSS API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned. + */ + export interface Schema$QuotaGroup { + /** + * Output only. List of all methods group quota applies to. + */ + methodDetails?: Schema$MethodDetails[]; + /** + * Identifier. The resource name of the quota group. Format: accounts/{account\}/quotas/{group\} Example: `accounts/12345678/quotas/css-products-insert` Note: The {group\} part is not guaranteed to follow a specific pattern. + */ + name?: string | null; + /** + * Output only. The maximum number of calls allowed per day for the group. + */ + quotaLimit?: string | null; + /** + * Output only. The maximum number of calls allowed per minute for the group. + */ + quotaMinuteLimit?: string | null; + /** + * Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC. + */ + quotaUsage?: string | null; + } /** * The request message for the `UpdateLabels` method. */ @@ -738,6 +797,7 @@ export namespace css_v1 { cssProductInputs: Resource$Accounts$Cssproductinputs; cssProducts: Resource$Accounts$Cssproducts; labels: Resource$Accounts$Labels; + quotas: Resource$Accounts$Quotas; constructor(context: APIRequestContext) { this.context = context; this.cssProductInputs = new Resource$Accounts$Cssproductinputs( @@ -745,6 +805,7 @@ export namespace css_v1 { ); this.cssProducts = new Resource$Accounts$Cssproducts(this.context); this.labels = new Resource$Accounts$Labels(this.context); + this.quotas = new Resource$Accounts$Quotas(this.context); } /** @@ -1356,7 +1417,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\}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 + * Identifier. 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; /** @@ -1975,7 +2036,7 @@ export namespace css_v1 { export interface Params$Resource$Accounts$Labels$Patch extends StandardParameters { /** - * The resource name of the label. Format: accounts/{account\}/labels/{label\} + * Identifier. The resource name of the label. Format: accounts/{account\}/labels/{label\} */ name?: string; @@ -1984,4 +2045,120 @@ export namespace css_v1 { */ requestBody?: Schema$AccountLabel; } + + export class Resource$Accounts$Quotas { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the daily call quota and usage per group for your CSS Center account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Accounts$Quotas$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Accounts$Quotas$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Quotas$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Quotas$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Quotas$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Quotas$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Quotas$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Quotas$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/quotas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Quotas$List + extends StandardParameters { + /** + * Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. + */ + pageToken?: string; + /** + * Required. The CSS account that owns the collection of method quotas and resources. In most cases, this is the CSS domain. Format: accounts/{account\} + */ + parent?: string; + } } diff --git a/src/apis/datacatalog/v1.ts b/src/apis/datacatalog/v1.ts index cc50b660f00..fcca123cd7b 100644 --- a/src/apis/datacatalog/v1.ts +++ b/src/apis/datacatalog/v1.ts @@ -994,6 +994,10 @@ export namespace datacatalog_v1 { * Opt-in status for the migration of Tag Templates to Dataplex. */ tagTemplateMigration?: string | null; + /** + * The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set. + */ + templateMigrationEnabledTime?: string | null; } /** * Specification that applies to a model. Valid only for entries with the `MODEL` type. @@ -2153,7 +2157,7 @@ export namespace datacatalog_v1 { */ project?: string; /** - * The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.topic.{PROJECT_ID\}.{TOPIC_ID\}` * `pubsub.topic.{PROJECT_ID\}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS\}`\` * `bigquery.table.{PROJECT_ID\}.{DATASET_ID\}.{TABLE_ID\}` * `bigquery.dataset.{PROJECT_ID\}.{DATASET_ID\}` * `datacatalog.entry.{PROJECT_ID\}.{LOCATION_ID\}.{ENTRY_GROUP_ID\}.{ENTRY_ID\}` Identifiers (`*_ID`) should comply with the [Lexical structure in Standard SQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical). + * The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.topic.{PROJECT_ID\}.{TOPIC_ID\}` * `pubsub.topic.{PROJECT_ID\}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS\}`\` * `bigquery.table.{PROJECT_ID\}.{DATASET_ID\}.{TABLE_ID\}` * `bigquery.dataset.{PROJECT_ID\}.{DATASET_ID\}` * `datacatalog.entry.{PROJECT_ID\}.{LOCATION_ID\}.{ENTRY_GROUP_ID\}.{ENTRY_ID\}` Identifiers (`*_ID`) should comply with the [Lexical structure in GoogleSQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical). */ sqlResource?: string; } diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index d236f54def2..0730e49b35b 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -2240,7 +2240,7 @@ export namespace datacatalog_v1beta1 { */ linkedResource?: string; /** - * The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s should satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. + * The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s should satisfy the GoogleSQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. */ sqlResource?: string; } diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index f6e1d89f80d..4f37590599c 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -1906,6 +1906,10 @@ export namespace dataflow_v1b3 { * Describes the state of a metric. */ export interface Schema$MetricUpdate { + /** + * Worker-computed aggregate value for the "Trie" aggregation kind. The only possible value type is a BoundedTrieNode. Introduced this field to avoid breaking older SDKs when Dataflow service starts to populate the `bounded_trie` field. + */ + boundedTrie?: any | null; /** * True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem. */ diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index 6661d9d1312..b1f84a32aff 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -124,6 +124,70 @@ export namespace dataform_v1beta1 { } } + /** + * Error table information, used to write error data into a BigQuery table. + */ + export interface Schema$ActionErrorTable { + /** + * Error table partition expiration in days. Only positive values are allowed. + */ + retentionDays?: number | null; + /** + * Error Table target. + */ + target?: Schema$Target; + } + /** + * Load definition for incremental load modes + */ + export interface Schema$ActionIncrementalLoadMode { + /** + * Column name for incremental load modes + */ + column?: string | null; + } + /** + * Simplified load configuration for actions + */ + export interface Schema$ActionLoadConfig { + /** + * Append into destination table + */ + append?: Schema$ActionSimpleLoadMode; + /** + * Insert records where the value exceeds the previous maximum value for a column in the destination table + */ + maximum?: Schema$ActionIncrementalLoadMode; + /** + * Replace destination table + */ + replace?: Schema$ActionSimpleLoadMode; + /** + * Insert records where the value of a column is not already present in the destination table + */ + unique?: Schema$ActionIncrementalLoadMode; + } + /** + * Simple load definition + */ + export interface Schema$ActionSimpleLoadMode {} + /** + * Definition of a SQL Data Preparation + */ + export interface Schema$ActionSqlDefinition { + /** + * Error table configuration, + */ + errorTable?: Schema$ActionErrorTable; + /** + * Load configuration. + */ + loadConfig?: Schema$ActionLoadConfig; + /** + * The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement. + */ + query?: string | null; + } /** * Represents an assertion upon a SQL query which is required return zero rows. */ @@ -199,6 +263,10 @@ export namespace dataform_v1beta1 { * Optional. The default schema (BigQuery dataset ID) for assertions. */ assertionSchema?: string | null; + /** + * Optional. The prefix to prepend to built-in assertion names. + */ + builtinAssertionNamePrefix?: string | null; /** * Optional. The suffix that should be appended to all database (Google Cloud project ID) names. */ @@ -425,6 +493,10 @@ export namespace dataform_v1beta1 { * The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. */ canonicalTarget?: Schema$Target; + /** + * The data preparation executed by this action. + */ + dataPreparation?: Schema$DataPreparation; /** * The declaration declared by this action. */ @@ -485,6 +557,52 @@ export namespace dataform_v1beta1 { */ kmsKeyVersionName?: string | null; } + /** + * Defines a compiled Data Preparation entity + */ + export interface Schema$DataPreparation { + /** + * SQL definition for a Data Preparation. Contains a SQL query and additional context information. + */ + contentsSql?: Schema$SqlDefinition; + /** + * The data preparation definition, stored as a YAML string. + */ + contentsYaml?: string | null; + /** + * A list of actions that this action depends on. + */ + dependencyTargets?: Schema$Target[]; + /** + * Whether this action is disabled (i.e. should not be run). + */ + disabled?: boolean | null; + /** + * Arbitrary, user-defined tags on this action. + */ + tags?: string[] | null; + } + /** + * Represents a workflow action that will run a Data Preparation. + */ + export interface Schema$DataPreparationAction { + /** + * SQL definition for a Data Preparation. Contains a SQL query and additional context information. + */ + contentsSql?: Schema$ActionSqlDefinition; + /** + * Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow. + */ + contentsYaml?: string | null; + /** + * Output only. The generated BigQuery SQL script that will be executed. For reference only. + */ + generatedSql?: string | null; + /** + * Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run. + */ + jobId?: string | null; + } /** * Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions. */ @@ -524,6 +642,19 @@ export namespace dataform_v1beta1 { * 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 {} + /** + * Error table information, used to write error data into a BigQuery table. + */ + export interface Schema$ErrorTable { + /** + * Error table partition expiration in days. Only positive values are allowed. + */ + retentionDays?: number | null; + /** + * Error Table target. + */ + target?: Schema$Target; + } /** * 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. */ @@ -645,6 +776,15 @@ export namespace dataform_v1beta1 { */ url?: string | null; } + /** + * Load definition for incremental load modes + */ + export interface Schema$IncrementalLoadMode { + /** + * Column name for incremental load modes + */ + column?: string | null; + } /** * Contains settings for relations of type `INCREMENTAL_TABLE`. */ @@ -839,6 +979,27 @@ export namespace dataform_v1beta1 { */ workspaces?: Schema$Workspace[]; } + /** + * Simplified load configuration for actions + */ + export interface Schema$LoadConfig { + /** + * Append into destination table + */ + append?: Schema$SimpleLoadMode; + /** + * Insert records where the value exceeds the previous maximum value for a column in the destination table + */ + maximum?: Schema$IncrementalLoadMode; + /** + * Replace destination table + */ + replace?: Schema$SimpleLoadMode; + /** + * Insert records where the value of a column is not already present in the destination table + */ + unique?: Schema$IncrementalLoadMode; + } /** * A resource that represents a Google Cloud location. */ @@ -1417,6 +1578,27 @@ export namespace dataform_v1beta1 { */ policy?: Schema$Policy; } + /** + * Simple load definition + */ + export interface Schema$SimpleLoadMode {} + /** + * Definition of a SQL Data Preparation + */ + export interface Schema$SqlDefinition { + /** + * Error table configuration, + */ + errorTable?: Schema$ErrorTable; + /** + * Load configuration. + */ + load?: Schema$LoadConfig; + /** + * The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement. + */ + query?: string | null; + } /** * Configures fields for performing SSH authentication. */ @@ -1507,6 +1689,10 @@ export namespace dataform_v1beta1 { * Optional. Optional schedule (in cron format) for automatic execution of this workflow config. */ cronSchedule?: string | null; + /** + * Optional. Disables automatic creation of workflow invocations. + */ + disabled?: boolean | null; /** * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */ @@ -1589,6 +1775,10 @@ export namespace dataform_v1beta1 { * Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. */ canonicalTarget?: Schema$Target; + /** + * Output only. The workflow action's data preparation action details. + */ + dataPreparationAction?: Schema$DataPreparationAction; /** * Output only. If and only if action's state is FAILED a failure reason is set. */ @@ -1962,7 +2152,7 @@ export namespace dataform_v1beta1 { } /** - * Update default config for a given project and location. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields + * Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2063,6 +2253,10 @@ export namespace dataform_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -2863,7 +3057,7 @@ export namespace dataform_v1beta1 { } /** - * Lists Repositories in a given project and location. + * Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2956,7 +3150,7 @@ export namespace dataform_v1beta1 { } /** - * Updates a single Repository. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields + * Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4417,7 +4611,7 @@ export namespace dataform_v1beta1 { } /** - * Updates a single ReleaseConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields + * Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4929,7 +5123,7 @@ export namespace dataform_v1beta1 { } /** - * Updates a single WorkflowConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields + * Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/datafusion/v1.ts b/src/apis/datafusion/v1.ts index 9e47a7e5b0d..e673c2a9b93 100644 --- a/src/apis/datafusion/v1.ts +++ b/src/apis/datafusion/v1.ts @@ -388,6 +388,10 @@ export namespace datafusion_v1 { * Output only. Additional information about the current state of this Data Fusion instance if available. */ stateMessage?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + */ + tags?: {[key: string]: string} | null; /** * Output only. The name of the tenant project. */ @@ -991,6 +995,10 @@ export namespace datafusion_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index e4bf9295dcd..357c72e1386 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -401,6 +401,10 @@ export namespace datafusion_v1beta1 { * Output only. Additional information about the current state of this Data Fusion instance if available. */ stateMessage?: string | null; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + */ + tags?: {[key: string]: string} | null; /** * Output only. The name of the tenant project. */ @@ -1137,6 +1141,10 @@ export namespace datafusion_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index bc1aa23115d..2d4000f558c 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -1509,6 +1509,10 @@ export namespace datamigration_v1 { * The number of CPU's in the VM instance. */ cpuCount?: number | null; + /** + * Optional. 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; } /** * Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema. @@ -1737,6 +1741,10 @@ export namespace datamigration_v1 { * Optional. Configuration for SQL Server homogeneous migration. */ sqlserverHomogeneousMigrationJobConfig?: Schema$SqlServerHomogeneousMigrationJobConfig; + /** + * Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. + */ + sqlserverToPostgresConfig?: Schema$SqlServerToPostgresConfig; /** * The current migration job state. */ @@ -2601,6 +2609,14 @@ export namespace datamigration_v1 { * Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier. */ database?: string | null; + /** + * Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier. + */ + schema?: string | null; + /** + * Optional. The table name. This will be required only if the object is a level below database or schema. + */ + table?: string | null; /** * Required. The type of the migration job object. */ @@ -2712,6 +2728,10 @@ export namespace datamigration_v1 { * If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. */ cloudSqlId?: string | null; + /** + * Required. The name of the specific database within the host. + */ + database?: string | null; /** * Forward SSH tunnel connectivity. */ @@ -2804,6 +2824,40 @@ export namespace datamigration_v1 { */ useDiffBackup?: boolean | null; } + /** + * Configuration for SQL Server as a source in a migration. + */ + export interface Schema$SqlServerSourceConfig { + /** + * Optional. The log sequence number (LSN) to start CDC data migration from. + */ + cdcStartPosition?: string | null; + /** + * Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase. + */ + maxConcurrentCdcConnections?: number | null; + /** + * Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase. + */ + maxConcurrentFullDumpConnections?: number | null; + /** + * Optional. Whether to skip full dump or not. + */ + skipFullDump?: boolean | null; + } + /** + * Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. + */ + export interface Schema$SqlServerToPostgresConfig { + /** + * Optional. Configuration for Postgres destination. + */ + postgresDestinationConfig?: Schema$PostgresDestinationConfig; + /** + * Optional. Configuration for SQL Server source. + */ + sqlserverSourceConfig?: Schema$SqlServerSourceConfig; + } /** * Response message for 'GenerateSshScript' request. */ @@ -3491,6 +3545,10 @@ export namespace datamigration_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/datamigration/v1beta1.ts b/src/apis/datamigration/v1beta1.ts index 408326653f3..8e21d107889 100644 --- a/src/apis/datamigration/v1beta1.ts +++ b/src/apis/datamigration/v1beta1.ts @@ -1073,6 +1073,10 @@ export namespace datamigration_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index c36fc90d912..b6162037d1d 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -565,7 +565,7 @@ export namespace dataplex_v1 { */ jsonOptions?: Schema$GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions; /** - * Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE\}" or TZ=${IANA_TIME_ZONE\}". The ${IANA_TIME_ZONE\} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. + * Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes.To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE\}" or TZ=${IANA_TIME_ZONE\}". The ${IANA_TIME_ZONE\} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. */ schedule?: string | null; } @@ -945,6 +945,10 @@ export namespace dataplex_v1 { * Output only. Configuration for metadata publishing. */ bigqueryPublishing?: Schema$GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing; + /** + * Output only. Describes result statistics of a data scan discovery job. + */ + scanStatistics?: Schema$GoogleCloudDataplexV1DataDiscoveryResultScanStatistics; } /** * Describes BigQuery publishing configurations. @@ -954,6 +958,51 @@ export namespace dataplex_v1 { * Output only. The BigQuery dataset the discovered tables are published to. */ dataset?: string | null; + /** + * Output only. The location of the BigQuery publishing dataset. + */ + location?: string | null; + } + /** + * Describes result statistics of a data scan discovery job. + */ + export interface Schema$GoogleCloudDataplexV1DataDiscoveryResultScanStatistics { + /** + * The data processed in bytes. + */ + dataProcessedBytes?: string | null; + /** + * The number of filesets created. + */ + filesetsCreated?: number | null; + /** + * The number of filesets deleted. + */ + filesetsDeleted?: number | null; + /** + * The number of filesets updated. + */ + filesetsUpdated?: number | null; + /** + * The number of files excluded. + */ + filesExcluded?: number | null; + /** + * The number of files scanned. + */ + scannedFileCount?: number | null; + /** + * The number of tables created. + */ + tablesCreated?: number | null; + /** + * The number of tables deleted. + */ + tablesDeleted?: number | null; + /** + * The number of tables updated. + */ + tablesUpdated?: number | null; } /** * Spec for a data discovery scan. @@ -1269,7 +1318,7 @@ export namespace dataplex_v1 { */ export interface Schema$GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport { /** - * Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + * Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID */ resultsTable?: string | null; } @@ -1300,7 +1349,7 @@ export namespace dataplex_v1 { */ export interface Schema$GoogleCloudDataplexV1DataQualityDimension { /** - * The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME" + * Optional. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. */ name?: string | null; } @@ -1313,7 +1362,7 @@ export namespace dataplex_v1 { */ dimension?: Schema$GoogleCloudDataplexV1DataQualityDimension; /** - * Whether the dimension passed or failed. + * Output only. Whether the dimension passed or failed. */ passed?: boolean | null; /** @@ -1330,11 +1379,11 @@ export namespace dataplex_v1 { */ columns?: Schema$GoogleCloudDataplexV1DataQualityColumnResult[]; /** - * A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. + * Output only. A list of results at the dimension level.A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it. */ dimensions?: Schema$GoogleCloudDataplexV1DataQualityDimensionResult[]; /** - * Overall data quality result -- true if all rules passed. + * Output only. Overall data quality result -- true if all rules passed. */ passed?: boolean | null; /** @@ -1342,15 +1391,15 @@ export namespace dataplex_v1 { */ postScanActionsResult?: Schema$GoogleCloudDataplexV1DataQualityResultPostScanActionsResult; /** - * The count of rows processed. + * Output only. The count of rows processed. */ rowCount?: string | null; /** - * A list of all the rules in a job, and their results. + * Output only. A list of all the rules in a job, and their results. */ rules?: Schema$GoogleCloudDataplexV1DataQualityRuleResult[]; /** - * The data scanned for this result. + * Output only. The data scanned for this result. */ scannedData?: Schema$GoogleCloudDataplexV1ScannedData; /** @@ -1492,31 +1541,31 @@ export namespace dataplex_v1 { */ assertionRowCount?: string | null; /** - * The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. + * Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. */ evaluatedCount?: string | null; /** - * The query to find rows that did not pass this rule.This field is only valid for row-level type rules. + * Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. */ failingRowsQuery?: string | null; /** - * The number of rows with null values in the specified column. + * Output only. The number of rows with null values in the specified column. */ nullCount?: string | null; /** - * Whether the rule passed or failed. + * Output only. Whether the rule passed or failed. */ passed?: boolean | null; /** - * This field is not set for rule SqlAssertion. + * Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. */ passedCount?: string | null; /** - * The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. + * Output only. The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. */ passRatio?: number | null; /** - * The rule specified in the DataQualitySpec, as is. + * Output only. The rule specified in the DataQualitySpec, as is. */ rule?: Schema$GoogleCloudDataplexV1DataQualityRule; } @@ -1681,7 +1730,7 @@ export namespace dataplex_v1 { */ export interface Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport { /** - * Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + * Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID */ resultsTable?: string | null; } @@ -2239,6 +2288,52 @@ export namespace dataplex_v1 { */ type?: string | null; } + /** + * A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK). + */ + export interface Schema$GoogleCloudDataplexV1EncryptionConfig { + /** + * Output only. The time when the Encryption configuration was created. + */ + createTime?: string | null; + /** + * Output only. The state of encryption of the databases. + */ + encryptionState?: string | null; + /** + * Etag of the EncryptionConfig. This is a strong etag. + */ + etag?: string | null; + /** + * Output only. Details of the failure if anything related to Cmek db fails. + */ + failureDetails?: Schema$GoogleCloudDataplexV1EncryptionConfigFailureDetails; + /** + * Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption. + */ + key?: string | null; + /** + * Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization\}/locations/{location\}/encryptionConfigs/{encryption_config\} Global location is not supported. + */ + name?: string | null; + /** + * Output only. The time when the Encryption configuration was last updated. + */ + updateTime?: string | null; + } + /** + * Details of the failure if anything related to Cmek db fails. + */ + export interface Schema$GoogleCloudDataplexV1EncryptionConfigFailureDetails { + /** + * Output only. The error code for the failure. + */ + errorCode?: string | null; + /** + * Output only. The error message will be shown to the user. Set only if the error code is REQUIRE_USER_ACTION. + */ + errorMessage?: string | null; + } /** * Represents tables and fileset metadata contained within a zone. */ @@ -2420,6 +2515,23 @@ export namespace dataplex_v1 { */ updateTime?: string | null; } + /** + * Payload associated with Entry related log events. + */ + export interface Schema$GoogleCloudDataplexV1EntryLinkEvent { + /** + * The type of the event. + */ + eventType?: string | null; + /** + * The log message. + */ + message?: string | null; + /** + * Name of the resource. + */ + resource?: string | null; + } /** * Information related to the source system of the data resource that is represented by the entry. */ @@ -3067,6 +3179,23 @@ export namespace dataplex_v1 { */ unreachableLocations?: string[] | null; } + /** + * List EncryptionConfigs Response + */ + export interface Schema$GoogleCloudDataplexV1ListEncryptionConfigsResponse { + /** + * The list of EncryptionConfigs under the given parent location. + */ + encryptionConfigs?: Schema$GoogleCloudDataplexV1EncryptionConfig[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachableLocations?: string[] | null; + } /** * List metadata entities response. */ @@ -3251,6 +3380,14 @@ export namespace dataplex_v1 { * Output only. The time when the metadata job was created. */ createTime?: string | null; + /** + * Output only. Export job result. + */ + exportResult?: Schema$GoogleCloudDataplexV1MetadataJobExportJobResult; + /** + * Export job specification. + */ + exportSpec?: Schema$GoogleCloudDataplexV1MetadataJobExportJobSpec; /** * Output only. Import job result. */ @@ -3284,6 +3421,57 @@ export namespace dataplex_v1 { */ updateTime?: string | null; } + /** + * Summary results from a metadata export job. The results are a snapshot of the metadata at the time when the job was created. The exported entries are saved to a Cloud Storage bucket. + */ + export interface Schema$GoogleCloudDataplexV1MetadataJobExportJobResult { + /** + * Output only. The error message if the metadata export job failed. + */ + errorMessage?: string | null; + /** + * Output only. The number of entries that were exported. + */ + exportedEntries?: string | null; + } + /** + * Job specification for a metadata export job. + */ + export interface Schema$GoogleCloudDataplexV1MetadataJobExportJobSpec { + /** + * Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket\}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket\}/{prefix\}/. The maximum length of the custom prefix is 128 characters. Dataplex constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.The bucket must be in the same VPC Service Controls perimeter as the job. + */ + outputPath?: string | null; + /** + * Required. The scope of the export job. + */ + scope?: Schema$GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope; + } + /** + * The scope of the export job. + */ + export interface Schema$GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope { + /** + * The aspect types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number\}/locations/{location\}/aspectTypes/{aspect_type_id\}. Only aspects that belong to the specified aspect types are affected by the job. + */ + aspectTypes?: string[] | null; + /** + * The entry groups whose metadata you want to export, in the format projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. Only the entries in the specified entry groups are exported.The entry groups must be in the same location and the same VPC Service Controls perimeter as the job.If you set the job scope to be a list of entry groups, then set the organization-level export flag to false and don't provide a list of projects. + */ + entryGroups?: string[] | null; + /** + * The entry types that are in scope for the export job, specified as relative resource names in the format projects/{project_id_or_number\}/locations/{location\}/entryTypes/{entry_type_id\}. Only entries that belong to the specified entry types are affected by the job. + */ + entryTypes?: string[] | null; + /** + * Whether the metadata export job is an organization-level export job. If true, the job exports the entries from the same organization and VPC Service Controls perimeter as the job. The project that the job belongs to determines the VPC Service Controls perimeter. If you set the job scope to be at the organization level, then don't provide a list of projects or entry groups. If false, you must specify a list of projects or a list of entry groups whose entries you want to export.The default is false. + */ + organizationLevel?: boolean | null; + /** + * The projects whose metadata you want to export, in the format projects/{project_id_or_number\}. Only the entries from the specified projects are exported.The projects must be in the same organization and VPC Service Controls perimeter as the job.If you set the job scope to be a list of projects, then set the organization-level export flag to false and don't provide a list of entry groups. + */ + projects?: string[] | null; + } /** * Results from a metadata import job. */ @@ -3338,7 +3526,7 @@ export namespace dataplex_v1 { */ sourceCreateTime?: string | null; /** - * Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted. + * Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata import job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted. */ sourceStorageUri?: string | null; } @@ -4120,7 +4308,7 @@ export namespace dataplex_v1 { */ jsonOptions?: Schema$GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions; /** - * Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE\}" or TZ=${IANA_TIME_ZONE\}". The ${IANA_TIME_ZONE\} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. + * Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes.To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE\}" or TZ=${IANA_TIME_ZONE\}". The ${IANA_TIME_ZONE\} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. */ schedule?: string | null; } @@ -4411,63 +4599,65 @@ export namespace dataplex_v1 { } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Create an EncryptionConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Encryptionconfigs$Getiampolicy, + create( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + create( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Encryptionconfigs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy; + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy; + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Create; options = {}; } @@ -4480,88 +4670,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/encryptionConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Delete an EncryptionConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Encryptionconfigs$Setiampolicy, + delete( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Delete, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + delete( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Delete, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - setIamPolicy( + delete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Encryptionconfigs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy; + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy; + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Delete; options = {}; } @@ -4574,66 +4766,537 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Get an EncryptionConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Encryptionconfigs$Testiampermissions, + get( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + get( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + get( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - testIamPermissions( + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Encryptionconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List EncryptionConfigs. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Encryptionconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Encryptionconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/encryptionConfigs').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 an EncryptionConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Encryptionconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Encryptionconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: | Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions | BodyResponseCallback @@ -4697,6 +5360,40 @@ export namespace dataplex_v1 { } } + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Create + extends StandardParameters { + /** + * Required. The ID of the EncryptionConfig to create. Currently, only a value of "default" is supported. + */ + encryptionConfigId?: string; + /** + * Required. The location at which the EncryptionConfig is to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EncryptionConfig; + } + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Delete + extends StandardParameters { + /** + * Optional. Etag of the EncryptionConfig. This is a strong etag. + */ + etag?: string; + /** + * Required. The name of the EncryptionConfig to delete. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Get + extends StandardParameters { + /** + * Required. The name of the EncryptionConfig to fetch. + */ + name?: string; + } export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy extends StandardParameters { /** @@ -4708,6 +5405,45 @@ export namespace dataplex_v1 { */ resource?: string; } + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$List + extends StandardParameters { + /** + * Optional. Filter the EncryptionConfigs to be returned. Using bare literals: (These values will be matched anywhere it may appear in the object's field values) * filter=some_value Using fields: (These values will be matched only in the specified field) * filter=some_field=some_value Supported fields: * name, key, create_time, update_time, encryption_state Example: * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config conjunctions: (AND, OR, NOT) * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (\>, <, \>=, <=, !=, =, :), * filter=create_time\>2024-05-01T00:00:00.000Z + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of EncryptionConfigs to return. The service may return fewer than this value. If unspecified, at most 10 EncryptionConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListEncryptionConfigs call. Provide this to retrieve the subsequent page. When paginating, the parameters - filter and order_by provided to ListEncryptionConfigs must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The location for which the EncryptionConfig is to be listed. + */ + parent?: string; + } + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization\}/locations/{location\}/encryptionConfigs/{encryption_config\} Global location is not supported. + */ + name?: string; + /** + * Optional. Mask of fields to update. The service treats an omitted field mask as an implied field mask equivalent to all fields that are populated (have a non-empty value). + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EncryptionConfig; + } export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy extends StandardParameters { /** @@ -5594,6 +6330,10 @@ export namespace dataplex_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/datastream/v1.ts b/src/apis/datastream/v1.ts index 73514d3d064..7d902cd032b 100644 --- a/src/apis/datastream/v1.ts +++ b/src/apis/datastream/v1.ts @@ -136,6 +136,10 @@ export namespace datastream_v1 { * Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. */ export interface Schema$BackfillAllStrategy { + /** + * MongoDB data source objects to avoid backfilling + */ + mongodbExcludedObjects?: Schema$MongodbCluster; /** * MySQL data source objects to avoid backfilling. */ @@ -310,6 +314,10 @@ export namespace datastream_v1 { * Labels. */ labels?: {[key: string]: string} | null; + /** + * MongoDB Connection Profile configuration. + */ + mongodbProfile?: Schema$MongodbProfile; /** * MySQL ConnectionProfile configuration. */ @@ -409,6 +417,10 @@ export namespace datastream_v1 { * The number of hierarchy levels below the current level to be retrieved. */ hierarchyDepth?: number | null; + /** + * MongoDB cluster to enrich with child data objects and metadata. + */ + mongodbCluster?: Schema$MongodbCluster; /** * MySQL RDBMS to enrich with child data objects and metadata. */ @@ -421,6 +433,10 @@ export namespace datastream_v1 { * PostgreSQL RDBMS to enrich with child data objects and metadata. */ postgresqlRdbms?: Schema$PostgresqlRdbms; + /** + * Salesforce organization to enrich with child data objects and metadata. + */ + salesforceOrg?: Schema$SalesforceOrg; /** * SQLServer RDBMS to enrich with child data objects and metadata. */ @@ -430,6 +446,10 @@ export namespace datastream_v1 { * Response from a discover request. */ export interface Schema$DiscoverConnectionProfileResponse { + /** + * Enriched MongoDB cluster. + */ + mongodbCluster?: Schema$MongodbCluster; /** * Enriched MySQL RDBMS object. */ @@ -442,6 +462,10 @@ export namespace datastream_v1 { * Enriched PostgreSQL RDBMS object. */ postgresqlRdbms?: Schema$PostgresqlRdbms; + /** + * Enriched Salesforce organization. + */ + salesforceOrg?: Schema$SalesforceOrg; /** * Enriched SQLServer RDBMS object. */ @@ -560,6 +584,19 @@ export namespace datastream_v1 { * Use GTID based replication. */ export interface Schema$Gtid {} + /** + * A HostAddress represents a transport end point, which is the combination of an IP address or hostname and a port number. + */ + export interface Schema$HostAddress { + /** + * Required. Hostname for the connection. + */ + hostname?: string | null; + /** + * Optional. Port for the connection. + */ + port?: number | null; + } /** * JSON file format configuration. */ @@ -735,6 +772,109 @@ export namespace datastream_v1 { * Merge mode defines that all changes to a table will be merged at the destination table. */ export interface Schema$Merge {} + /** + * MongoDB Cluster structure. + */ + export interface Schema$MongodbCluster { + /** + * MongoDB databases in the cluster. + */ + databases?: Schema$MongodbDatabase[]; + } + /** + * MongoDB Collection. + */ + export interface Schema$MongodbCollection { + /** + * Collection name. + */ + collection?: string | null; + /** + * Fields in the collection. + */ + fields?: Schema$MongodbField[]; + } + /** + * MongoDB Database. + */ + export interface Schema$MongodbDatabase { + /** + * Collections in the database. + */ + collections?: Schema$MongodbCollection[]; + /** + * Database name. + */ + database?: string | null; + } + /** + * MongoDB Field. + */ + export interface Schema$MongodbField { + /** + * Field name. + */ + field?: string | null; + } + /** + * MongoDB data source object identifier. + */ + export interface Schema$MongodbObjectIdentifier { + /** + * Required. The collection name. + */ + collection?: string | null; + /** + * Required. The database name. + */ + database?: string | null; + } + /** + * MongoDB profile. + */ + export interface Schema$MongodbProfile { + /** + * Required. List of host addresses for a MongoDB cluster. + */ + hostAddresses?: Schema$HostAddress[]; + /** + * Optional. Password for the MongoDB connection. Mutually exclusive with the `secret_manager_stored_password` field. + */ + password?: string | null; + /** + * Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. + */ + replicaSet?: string | null; + /** + * Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field. + */ + secretManagerStoredPassword?: string | null; + /** + * Srv connection format. + */ + srvConnectionFormat?: Schema$SrvConnectionFormat; + /** + * Standard connection format. + */ + standardConnectionFormat?: Schema$StandardConnectionFormat; + /** + * Required. Username for the MongoDB connection. + */ + username?: string | null; + } + /** + * MongoDB source configuration. + */ + export interface Schema$MongodbSourceConfig { + /** + * MongoDB collections to exclude from the stream. + */ + excludeObjects?: Schema$MongodbCluster; + /** + * MongoDB collections to include in the stream. + */ + includeObjects?: Schema$MongodbCluster; + } /** * CDC strategy to start replicating from the most recent position in the source. */ @@ -1430,6 +1570,10 @@ export namespace datastream_v1 { * Output only. Identifier. The resource's name. */ name?: string | null; + /** + * PSC Interface Config. + */ + pscInterfaceConfig?: Schema$PscInterfaceConfig; /** * Output only. Reserved for future use. */ @@ -1460,6 +1604,15 @@ export namespace datastream_v1 { */ privateConnection?: string | null; } + /** + * The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer's PSC. + */ + export interface Schema$PscInterfaceConfig { + /** + * Required. Fully qualified name of the Network Attachment that Datastream will connect to. Format: `projects/{{project\}\}/regions/{{region\}\}/networkAttachments/{{name\}\}` + */ + networkAttachment?: string | null; + } /** * The route resource is the child of the private connection resource, used for defining a route for a private connection. */ @@ -1627,6 +1780,10 @@ export namespace datastream_v1 { * The configuration of the stream source. */ export interface Schema$SourceConfig { + /** + * MongoDB data source configuration. + */ + mongodbSourceConfig?: Schema$MongodbSourceConfig; /** * MySQL data source configuration. */ @@ -1665,6 +1822,10 @@ export namespace datastream_v1 { * Represents an identifier of an object in the data source. */ export interface Schema$SourceObjectIdentifier { + /** + * MongoDB data source object identifier. + */ + mongodbIdentifier?: Schema$MongodbObjectIdentifier; /** * Mysql data source object identifier. */ @@ -1867,6 +2028,14 @@ export namespace datastream_v1 { * Configuration to use Transaction Logs CDC read method. */ export interface Schema$SqlServerTransactionLogs {} + /** + * Srv connection format. + */ + export interface Schema$SrvConnectionFormat {} + /** + * Standard connection format. + */ + export interface Schema$StandardConnectionFormat {} /** * Request for manually initiating a backfill job for a specific stream object. */ @@ -2431,6 +2600,10 @@ export namespace datastream_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -3903,6 +4076,10 @@ export namespace datastream_v1 { * 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 will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * Optional. When supplied with PSC Interface config, will get/create the tenant project required for the customer to allow list and won't actually create the private connection. + */ + validateOnly?: boolean; /** * Request body metadata diff --git a/src/apis/datastream/v1alpha1.ts b/src/apis/datastream/v1alpha1.ts index ba803649b77..af0ceeede7d 100644 --- a/src/apis/datastream/v1alpha1.ts +++ b/src/apis/datastream/v1alpha1.ts @@ -1502,6 +1502,10 @@ export namespace datastream_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/deploymentmanager/alpha.ts b/src/apis/deploymentmanager/alpha.ts index 2447504fa1d..460b0c4a449 100644 --- a/src/apis/deploymentmanager/alpha.ts +++ b/src/apis/deploymentmanager/alpha.ts @@ -610,6 +610,10 @@ export namespace deploymentmanager_alpha { value?: string | null; } export interface Schema$InstancesBulkInsertOperationMetadata { + /** + * [Output Only] The machine type of the VMs that were created used internally only by KCP flex bulk insert. + */ + machineType?: string | null; /** * Status information per location (location name is key). Example key: zones/us-central1-a */ @@ -794,6 +798,10 @@ export namespace deploymentmanager_alpha { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; + /** + * This field is used internally by the Autoscaler team and should not be promoted to "alpha/beta/v1". + */ + setAutoscalerLinkOperationMetadata?: Schema$SetAutoscalerLinkOperationMetadata; /** * [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. */ @@ -1091,6 +1099,12 @@ export namespace deploymentmanager_alpha { */ email?: string | null; } + export interface Schema$SetAutoscalerLinkOperationMetadata { + /** + * List of zonal IGM IDs part of the RMIG. + */ + zonalIgmIds?: string[] | null; + } export interface Schema$SetCommonInstanceMetadataOperationMetadata { /** * [Output Only] The client operation id. diff --git a/src/apis/deploymentmanager/v2.ts b/src/apis/deploymentmanager/v2.ts index aecf4b84b14..630e972e1b7 100644 --- a/src/apis/deploymentmanager/v2.ts +++ b/src/apis/deploymentmanager/v2.ts @@ -414,6 +414,10 @@ export namespace deploymentmanager_v2 { name?: string | null; } export interface Schema$InstancesBulkInsertOperationMetadata { + /** + * [Output Only] The machine type of the VMs that were created used internally only by KCP flex bulk insert. + */ + machineType?: string | null; /** * Status information per location (location name is key). Example key: zones/us-central1-a */ @@ -573,6 +577,10 @@ export namespace deploymentmanager_v2 { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; + /** + * This field is used internally by the Autoscaler team and should not be promoted to "alpha/beta/v1". + */ + setAutoscalerLinkOperationMetadata?: Schema$SetAutoscalerLinkOperationMetadata; /** * [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. */ @@ -802,6 +810,12 @@ export namespace deploymentmanager_v2 { message?: string; }> | null; } + export interface Schema$SetAutoscalerLinkOperationMetadata { + /** + * List of zonal IGM IDs part of the RMIG. + */ + zonalIgmIds?: string[] | null; + } export interface Schema$SetCommonInstanceMetadataOperationMetadata { /** * [Output Only] The client operation id. diff --git a/src/apis/deploymentmanager/v2beta.ts b/src/apis/deploymentmanager/v2beta.ts index 81762597fa5..fb754b82200 100644 --- a/src/apis/deploymentmanager/v2beta.ts +++ b/src/apis/deploymentmanager/v2beta.ts @@ -581,6 +581,10 @@ export namespace deploymentmanager_v2beta { value?: string | null; } export interface Schema$InstancesBulkInsertOperationMetadata { + /** + * [Output Only] The machine type of the VMs that were created used internally only by KCP flex bulk insert. + */ + machineType?: string | null; /** * Status information per location (location name is key). Example key: zones/us-central1-a */ @@ -740,6 +744,10 @@ export namespace deploymentmanager_v2beta { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; + /** + * This field is used internally by the Autoscaler team and should not be promoted to "alpha/beta/v1". + */ + setAutoscalerLinkOperationMetadata?: Schema$SetAutoscalerLinkOperationMetadata; /** * [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. */ @@ -1021,6 +1029,12 @@ export namespace deploymentmanager_v2beta { */ email?: string | null; } + export interface Schema$SetAutoscalerLinkOperationMetadata { + /** + * List of zonal IGM IDs part of the RMIG. + */ + zonalIgmIds?: string[] | null; + } export interface Schema$SetCommonInstanceMetadataOperationMetadata { /** * [Output Only] The client operation id. diff --git a/src/apis/developerconnect/v1.ts b/src/apis/developerconnect/v1.ts index 4d372ae441d..6c8775ce855 100644 --- a/src/apis/developerconnect/v1.ts +++ b/src/apis/developerconnect/v1.ts @@ -124,6 +124,43 @@ export namespace developerconnect_v1 { } } + /** + * AccountConnector encapsulates what a platform administrator needs to configure for users to connect to the service providers, which includes, among other fields, the OAuth client ID, client secret, and authorization and token endpoints. + */ + export interface Schema$AccountConnector { + /** + * Optional. Allows users to store small amounts of arbitrary data. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. The timestamp when the accountConnector was created. + */ + createTime?: 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. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the accountConnector, in the format `projects/{project\}/locations/{location\}/accountConnectors/{account_connector_id\}`. + */ + name?: string | null; + /** + * Output only. Start OAuth flow by clicking on this URL. + */ + oauthStartUri?: string | null; + /** + * Provider OAuth config. + */ + providerOauthConfig?: Schema$ProviderOAuthConfig; + /** + * Output only. The timestamp when the accountConnector was updated. + */ + updateTime?: string | null; + } /** * Configuration for connections to an instance of Bitbucket Cloud. */ @@ -276,6 +313,44 @@ export namespace developerconnect_v1 { * 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 {} + /** + * Message for representing an error from exchanging OAuth tokens. + */ + export interface Schema$ExchangeError { + /** + * https://datatracker.ietf.org/doc/html/rfc6749#section-5.2 - error + */ + code?: string | null; + /** + * https://datatracker.ietf.org/doc/html/rfc6749#section-5.2 - error_description + */ + description?: string | null; + } + /** + * Message for fetching an OAuth access token. + */ + export interface Schema$FetchAccessTokenRequest {} + /** + * Message for responding to getting an OAuth access token. + */ + export interface Schema$FetchAccessTokenResponse { + /** + * The error resulted from exchanging OAuth tokens from the service provider. + */ + exchangeError?: Schema$ExchangeError; + /** + * Expiration timestamp. Can be empty if unknown or non-expiring. + */ + expirationTime?: string | null; + /** + * The scopes of the access token. + */ + scopes?: string[] | null; + /** + * The token content. + */ + token?: string | null; + } /** * Response of fetching github installations. */ @@ -591,6 +666,23 @@ export namespace developerconnect_v1 { */ cloneUri?: string | null; } + /** + * Message for response to listing AccountConnectors + */ + export interface Schema$ListAccountConnectorsResponse { + /** + * The list of AccountConnectors + */ + accountConnectors?: Schema$AccountConnector[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Message for response to listing Connections */ @@ -651,6 +743,23 @@ export namespace developerconnect_v1 { */ operations?: Schema$Operation[]; } + /** + * Message for response to listing Users + */ + export interface Schema$ListUsersResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + /** + * The list of Users + */ + users?: Schema$User[]; + } /** * A resource that represents a Google Cloud location. */ @@ -792,6 +901,19 @@ export namespace developerconnect_v1 { */ body?: Schema$HttpBody; } + /** + * ProviderOAuthConfig is the OAuth config for a provider. + */ + export interface Schema$ProviderOAuthConfig { + /** + * Required. User selected scopes to apply to the Oauth config In the event of changing scopes, user records under AccountConnector will be deleted and users will re-auth again. + */ + scopes?: string[] | null; + /** + * Immutable. Developer Connect provided OAuth. + */ + systemProviderId?: string | null; + } /** * ServiceDirectoryConfig represents Service Directory configuration for a connection. */ @@ -818,6 +940,27 @@ export namespace developerconnect_v1 { */ message?: string | null; } + /** + * User represents a user connected to the service providers through a AccountConnector. + */ + export interface Schema$User { + /** + * Output only. The timestamp when the user was created. + */ + createTime?: string | null; + /** + * Output only. Developer Connect automatically converts user identity to some human readable description, e.g., email address. + */ + displayName?: string | null; + /** + * Output only. The timestamp when the token was last requested. + */ + lastTokenRequestTime?: string | null; + /** + * Identifier. Resource name of the user, in the format `projects/x/locations/x/accountConnectors/x/users/x`. + */ + name?: string | null; + } /** * Represents a personal access token that authorized the Connection, and associated metadata. */ @@ -843,10 +986,13 @@ export namespace developerconnect_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + accountConnectors: Resource$Projects$Locations$Accountconnectors; connections: Resource$Projects$Locations$Connections; operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.accountConnectors = + new Resource$Projects$Locations$Accountconnectors(this.context); this.connections = new Resource$Projects$Locations$Connections( this.context ); @@ -1045,6 +1191,10 @@ export namespace developerconnect_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -1063,6 +1213,1104 @@ export namespace developerconnect_v1 { pageToken?: string; } + export class Resource$Projects$Locations$Accountconnectors { + context: APIRequestContext; + users: Resource$Projects$Locations$Accountconnectors$Users; + constructor(context: APIRequestContext) { + this.context = context; + this.users = new Resource$Projects$Locations$Accountconnectors$Users( + this.context + ); + } + + /** + * Creates a new AccountConnector 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$Accountconnectors$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Accountconnectors$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Accountconnectors$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Accountconnectors$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Accountconnectors$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://developerconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/accountConnectors').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 AccountConnector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Accountconnectors$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Accountconnectors$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Accountconnectors$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Accountconnectors$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Accountconnectors$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Delete; + 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}').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 AccountConnector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Accountconnectors$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Accountconnectors$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Accountconnectors$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Accountconnectors$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Accountconnectors$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Accountconnectors$Get; + 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}').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 AccountConnectors 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$Accountconnectors$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Accountconnectors$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Accountconnectors$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Accountconnectors$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Accountconnectors$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://developerconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/accountConnectors').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 AccountConnector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Accountconnectors$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Accountconnectors$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Accountconnectors$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Accountconnectors$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Accountconnectors$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Patch; + 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}').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$Accountconnectors$Create + extends StandardParameters { + /** + * Required. The ID to use for the AccountConnector, which will become the final component of the AccountConnector's resource name. Its format should adhere to https://google.aip.dev/122#resource-id-segments Names must be unique per-project per-location. + */ + accountConnectorId?: string; + /** + * Required. Location resource name as the account_connector’s parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validate the request, but do not actually post it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountConnector; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$Delete + extends StandardParameters { + /** + * Optional. The current etag of the AccountConnectorn. If an etag is provided and does not match the current etag of the AccountConnector, deletion will be blocked and an ABORTED error will be returned. + */ + etag?: string; + /** + * Optional. If set to true, any Users from this AccountConnector will also be deleted. (Otherwise, the request will only work if the AccountConnector has no Users.) + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validate the request, but do not actually post it. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$Get + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$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. Parent value for ListAccountConnectorsRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$Patch + extends StandardParameters { + /** + * Optional. If set to true, and the accountConnector is not found a new accountConnector will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input accountConnector has all the necessary + */ + allowMissing?: boolean; + /** + * Identifier. The resource name of the accountConnector, in the format `projects/{project\}/locations/{location\}/accountConnectors/{account_connector_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; + /** + * Optional. The list of fields to be updated. + */ + updateMask?: string; + /** + * Optional. If set, validate the request, but do not actually post it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountConnector; + } + + export class Resource$Projects$Locations$Accountconnectors$Users { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a single 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. + */ + delete( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Accountconnectors$Users$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Users$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Users$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Users$Delete; + 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}').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); + } + } + + /** + * Delete the User based on the user credentials. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself, + options: StreamMethodOptions + ): GaxiosPromise; + deleteSelf( + params?: Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself, + options?: MethodOptions + ): GaxiosPromise; + deleteSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself, + callback: BodyResponseCallback + ): void; + deleteSelf(callback: BodyResponseCallback): void; + deleteSelf( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself; + 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}/users:deleteSelf').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); + } + } + + /** + * Fetches OAuth access token based on end user credentials. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchAccessToken( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken, + options: StreamMethodOptions + ): GaxiosPromise; + fetchAccessToken( + params?: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken, + options?: MethodOptions + ): GaxiosPromise; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + callback: BodyResponseCallback + ): void; + fetchAccessToken( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://developerconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+accountConnector}/users:fetchAccessToken' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['accountConnector'], + pathParams: ['accountConnector'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetch the User based on the user credentials. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself, + options: StreamMethodOptions + ): GaxiosPromise; + fetchSelf( + params?: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself, + options?: MethodOptions + ): GaxiosPromise; + fetchSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchSelf( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself, + callback: BodyResponseCallback + ): void; + fetchSelf(callback: BodyResponseCallback): void; + fetchSelf( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself; + 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}/users:fetchSelf').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 Users in a given project, location, and account_connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Accountconnectors$Users$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Accountconnectors$Users$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Accountconnectors$Users$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Accountconnectors$Users$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Accountconnectors$Users$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Accountconnectors$Users$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://developerconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/users').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Accountconnectors$Users$Delete + extends StandardParameters { + /** + * 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; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validate the request, but do not actually post it. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$Users$Deleteself + extends StandardParameters { + /** + * Required. Name of the AccountConnector resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchaccesstoken + extends StandardParameters { + /** + * Required. The resource name of the AccountConnector in the format `projects/x/locations/x/accountConnectors/x`. + */ + accountConnector?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FetchAccessTokenRequest; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$Users$Fetchself + extends StandardParameters { + /** + * Required. Name of the AccountConnector resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Accountconnectors$Users$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. Parent value for ListUsersRequest + */ + parent?: string; + } + export class Resource$Projects$Locations$Connections { context: APIRequestContext; gitRepositoryLinks: Resource$Projects$Locations$Connections$Gitrepositorylinks; diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 48d4525141b..a72d2870d7e 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -1801,6 +1801,18 @@ export namespace dialogflow_v2 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -1834,11 +1846,24 @@ export namespace dialogflow_v2 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -2917,6 +2942,10 @@ export namespace dialogflow_v2 { * The natural language text to be processed. */ text?: Schema$GoogleCloudDialogflowCxV3TextInput; + /** + * The results of a tool executed by the client. + */ + toolCallResult?: Schema$GoogleCloudDialogflowCxV3ToolCallResult; } /** * Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. @@ -2970,6 +2999,10 @@ export namespace dialogflow_v2 { * Returns a text response. */ text?: Schema$GoogleCloudDialogflowCxV3ResponseMessageText; + /** + * Returns the definition of a tool call that should be executed by the client. + */ + toolCall?: Schema$GoogleCloudDialogflowCxV3ToolCall; } /** * Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. @@ -3250,6 +3283,53 @@ export namespace dialogflow_v2 { */ text?: string | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action that has been executed by the client. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowCxV3ToolCallResultError; + /** + * The tool call's output parameters. + */ + outputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. */ @@ -3389,6 +3469,18 @@ export namespace dialogflow_v2 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -3422,11 +3514,24 @@ export namespace dialogflow_v2 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -4429,6 +4534,23 @@ export namespace dialogflow_v2 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2beta1ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2beta1ToolCallResult; } /** * Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation. @@ -6016,6 +6138,65 @@ export namespace dialogflow_v2 { */ dtmfEvents?: string[] | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Output only. Create time of the tool call. + */ + createTime?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Only populated if the response content is utf-8 encoded. + */ + content?: string | null; + /** + * Output only. Create time of the tool call result. + */ + createTime?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowV2beta1ToolCallResultError; + /** + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). + */ + rawContent?: string | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * The request message for a webhook call. */ @@ -6561,6 +6742,23 @@ export namespace dialogflow_v2 { */ state?: string | null; } + /** + * Pronunciation customization for a phrase. + */ + export interface Schema$GoogleCloudDialogflowV2CustomPronunciationParams { + /** + * The phonetic encoding of the phrase. + */ + phoneticEncoding?: string | null; + /** + * The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence. + */ + phrase?: string | null; + /** + * The pronunciation of the phrase. This must be in the phonetic encoding specified above. + */ + pronunciation?: string | null; + } /** * Metadata for DeleteConversationDataset. */ @@ -7288,6 +7486,10 @@ export namespace dialogflow_v2 { * Input of prebuilt Summarization feature. */ summarizationContext?: Schema$GoogleCloudDialogflowV2SummarizationContext; + /** + * Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`. + */ + tools?: string[] | null; /** * Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation. */ @@ -7309,6 +7511,23 @@ export namespace dialogflow_v2 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2ToolCallResult; } /** * Defines the Human Agent Assist to connect to a conversation. @@ -7785,7 +8004,7 @@ export namespace dialogflow_v2 { */ enableWordInfo?: boolean | null; /** - * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not set, the language is inferred from the ConversationProfile.stt_config. */ languageCode?: string | null; /** @@ -9553,7 +9772,7 @@ export namespace dialogflow_v2 { */ enableWordInfo?: boolean | null; /** - * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not specified, the default language configured at ConversationProfile is used. */ languageCode?: string | null; /** @@ -9950,6 +10169,10 @@ export namespace dialogflow_v2 { * Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number | null; + /** + * Optional. The custom pronunciations for the synthesized audio. + */ + pronunciations?: Schema$GoogleCloudDialogflowV2CustomPronunciationParams[]; /** * Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or \> 4.0 will return an error. */ @@ -9999,6 +10222,65 @@ export namespace dialogflow_v2 { [key: string]: Schema$GoogleCloudDialogflowV2SynthesizeSpeechConfig; } | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Output only. Create time of the tool call. + */ + createTime?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Only populated if the response content is utf-8 encoded. + */ + content?: string | null; + /** + * Output only. Create time of the tool call result. + */ + createTime?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowV2ToolCallResultError; + /** + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). + */ + rawContent?: string | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * The request message for Agents.TrainAgent. */ @@ -24945,6 +25227,10 @@ export namespace dialogflow_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index e4c2ad4f4b1..2c1eda88844 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -1801,6 +1801,18 @@ export namespace dialogflow_v2beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -1834,11 +1846,24 @@ export namespace dialogflow_v2beta1 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -2917,6 +2942,10 @@ export namespace dialogflow_v2beta1 { * The natural language text to be processed. */ text?: Schema$GoogleCloudDialogflowCxV3TextInput; + /** + * The results of a tool executed by the client. + */ + toolCallResult?: Schema$GoogleCloudDialogflowCxV3ToolCallResult; } /** * Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. @@ -2970,6 +2999,10 @@ export namespace dialogflow_v2beta1 { * Returns a text response. */ text?: Schema$GoogleCloudDialogflowCxV3ResponseMessageText; + /** + * Returns the definition of a tool call that should be executed by the client. + */ + toolCall?: Schema$GoogleCloudDialogflowCxV3ToolCall; } /** * Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. @@ -3250,6 +3283,53 @@ export namespace dialogflow_v2beta1 { */ text?: string | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action that has been executed by the client. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowCxV3ToolCallResultError; + /** + * The tool call's output parameters. + */ + outputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. */ @@ -3389,6 +3469,18 @@ export namespace dialogflow_v2beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -3422,11 +3514,24 @@ export namespace dialogflow_v2beta1 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -4618,6 +4723,23 @@ export namespace dialogflow_v2beta1 { */ parent?: string | null; } + /** + * Pronunciation customization for a phrase. + */ + export interface Schema$GoogleCloudDialogflowV2beta1CustomPronunciationParams { + /** + * The phonetic encoding of the phrase. + */ + phoneticEncoding?: string | null; + /** + * The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence. + */ + phrase?: string | null; + /** + * The pronunciation of the phrase. This must be in the phonetic encoding specified above. + */ + pronunciation?: string | null; + } /** * The request to detect user's intent. */ @@ -5270,6 +5392,10 @@ export namespace dialogflow_v2beta1 { * Input of Summarization feature. */ summarizationContext?: Schema$GoogleCloudDialogflowV2beta1SummarizationContext; + /** + * Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`. + */ + tools?: string[] | null; /** * Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation. */ @@ -5291,6 +5417,23 @@ export namespace dialogflow_v2beta1 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2beta1ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2beta1ToolCallResult; } /** * Defines the Human Agent Assistant to connect to a conversation. @@ -5740,7 +5883,7 @@ export namespace dialogflow_v2beta1 { */ enableWordInfo?: boolean | null; /** - * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not set, the language is inferred from the ConversationProfile.stt_config. */ languageCode?: string | null; /** @@ -7855,7 +7998,7 @@ export namespace dialogflow_v2beta1 { */ enableWordInfo?: boolean | null; /** - * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. If not specified, the default language configured at ConversationProfile is used. */ languageCode?: string | null; /** @@ -8389,6 +8532,10 @@ export namespace dialogflow_v2beta1 { * Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number | null; + /** + * Optional. The custom pronunciations for the synthesized audio. + */ + pronunciations?: Schema$GoogleCloudDialogflowV2beta1CustomPronunciationParams[]; /** * Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or \> 4.0 will return an error. */ @@ -8447,6 +8594,65 @@ export namespace dialogflow_v2beta1 { [key: string]: Schema$GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig; } | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Output only. Create time of the tool call. + */ + createTime?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Only populated if the response content is utf-8 encoded. + */ + content?: string | null; + /** + * Output only. Create time of the tool call result. + */ + createTime?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowV2beta1ToolCallResultError; + /** + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). + */ + rawContent?: string | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * The request message for Agents.TrainAgent. */ @@ -8953,6 +9159,23 @@ export namespace dialogflow_v2beta1 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2ToolCallResult; } /** * Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation. @@ -10184,6 +10407,65 @@ export namespace dialogflow_v2beta1 { */ summary?: string | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Output only. Create time of the tool call. + */ + createTime?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Only populated if the response content is utf-8 encoded. + */ + content?: string | null; + /** + * Output only. Create time of the tool call result. + */ + createTime?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowV2ToolCallResultError; + /** + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). + */ + rawContent?: string | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * Metadata for a ConversationModels.UndeployConversationModel operation. */ @@ -24203,6 +24485,10 @@ export namespace dialogflow_v2beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index f5bf3c9a478..a6058836401 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -124,6 +124,31 @@ export namespace dialogflow_v3 { } } + /** + * Action performed by end user or Dialogflow agent in the conversation. + */ + export interface Schema$GoogleCloudDialogflowCxV3Action { + /** + * Optional. Action performed by the agent as a message. + */ + agentUtterance?: Schema$GoogleCloudDialogflowCxV3AgentUtterance; + /** + * Optional. Action performed on behalf of the agent by invoking a CX flow. + */ + flowInvocation?: Schema$GoogleCloudDialogflowCxV3FlowInvocation; + /** + * Optional. Action performed on behalf of the agent by invoking a child playbook. + */ + playbookInvocation?: Schema$GoogleCloudDialogflowCxV3PlaybookInvocation; + /** + * Optional. Action performed on behalf of the agent by calling a plugin tool. + */ + toolUse?: Schema$GoogleCloudDialogflowCxV3ToolUse; + /** + * Optional. Agent obtained a message from the customer. + */ + userUtterance?: Schema$GoogleCloudDialogflowCxV3UserUtterance; + } /** * Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-\>Flow-\>Page-\>Fulfillment/Parameter. */ @@ -289,9 +314,13 @@ export namespace dialogflow_v3 { */ speechToTextSettings?: Schema$GoogleCloudDialogflowCxV3SpeechToTextSettings; /** - * Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + * Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. */ startFlow?: string | null; + /** + * Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. + */ + startPlaybook?: string | null; /** * The list of all languages supported by the agent (except for the `default_language_code`). */ @@ -383,6 +412,15 @@ export namespace dialogflow_v3 { */ defaultEndUserMetadata?: {[key: string]: any} | null; } + /** + * AgentUtterance represents one message sent by the agent. + */ + export interface Schema$GoogleCloudDialogflowCxV3AgentUtterance { + /** + * Required. Message content in text. + */ + text?: string | null; + } /** * The response message for Agents.GetAgentValidationResult. */ @@ -2041,6 +2079,18 @@ export namespace dialogflow_v3 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -2074,11 +2124,24 @@ export namespace dialogflow_v3 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -2988,6 +3051,55 @@ export namespace dialogflow_v3 { */ event?: string | null; } + /** + * Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. + */ + export interface Schema$GoogleCloudDialogflowCxV3Example { + /** + * Required. The ordered list of actions performed by the end user and the Dialogflow agent. + */ + actions?: Schema$GoogleCloudDialogflowCxV3Action[]; + /** + * Required. Example's output state. + */ + conversationState?: string | null; + /** + * Output only. The timestamp of initial example creation. + */ + createTime?: string | null; + /** + * Optional. The high level concise description of the example. The max number of characters is 200. + */ + description?: string | null; + /** + * Required. The display name of the example. + */ + displayName?: string | null; + /** + * Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents. + */ + languageCode?: string | null; + /** + * The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + */ + name?: string | null; + /** + * Optional. The input to the playbook in the example. + */ + playbookInput?: Schema$GoogleCloudDialogflowCxV3PlaybookInput; + /** + * Optional. The output of the playbook in the example. + */ + playbookOutput?: Schema$GoogleCloudDialogflowCxV3PlaybookOutput; + /** + * Output only. Estimated number of tokes current example takes when sent to the LLM. + */ + tokenCount?: string | null; + /** + * Output only. Last time the example was updated. + */ + updateTime?: string | null; + } /** * Represents an experiment in an environment. */ @@ -3303,6 +3415,19 @@ export namespace dialogflow_v3 { */ intentsUri?: string | null; } + /** + * The request message for Playbooks.ExportPlaybook. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportPlaybookRequest { + /** + * Optional. The data format of the exported agent. If not specified, `BLOB` is assumed. + */ + dataFormat?: string | null; + /** + * Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the playbook to. The format of this URI must be `gs:///`. If left unspecified, the serialized playbook is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + playbookUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -3408,6 +3533,23 @@ export namespace dialogflow_v3 { */ globalImportStrategy?: string | null; } + /** + * Stores metadata of the invocation of a CX flow. + */ + export interface Schema$GoogleCloudDialogflowCxV3FlowInvocation { + /** + * Output only. The display name of the flow. + */ + displayName?: string | null; + /** + * Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`. + */ + flow?: string | null; + /** + * Required. Flow invocation's output state. + */ + flowState?: string | null; + } /** * Settings for multi-lingual agents. */ @@ -3649,6 +3791,10 @@ export namespace dialogflow_v3 { * Language for this settings. */ languageCode?: string | null; + /** + * LLM model settings. + */ + llmModelSettings?: Schema$GoogleCloudDialogflowCxV3LlmModelSettings; /** * Format: `projects//locations//agents//generativeSettings`. */ @@ -3721,6 +3867,10 @@ export namespace dialogflow_v3 { * Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. */ displayName?: string | null; + /** + * The LLM model settings. + */ + llmModelSettings?: Schema$GoogleCloudDialogflowCxV3LlmModelSettings; /** * Parameters passed to the LLM to configure its behavior. */ @@ -3900,6 +4050,23 @@ export namespace dialogflow_v3 { */ intentDisplayNames?: string[] | null; } + /** + * The request message for Playbooks.ImportPlaybook. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportPlaybookRequest { + /** + * Optional. Specifies the import strategy used when resolving resource conflicts. + */ + importStrategy?: Schema$GoogleCloudDialogflowCxV3PlaybookImportStrategy; + /** + * Uncompressed raw byte content for playbook. + */ + playbookContent?: string | null; + /** + * [Dialogflow access control] (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + playbookUri?: string | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -4233,6 +4400,19 @@ export namespace dialogflow_v3 { */ nextPageToken?: string | null; } + /** + * The response message for Examples.ListExamples. + */ + export interface Schema$GoogleCloudDialogflowCxV3ListExamplesResponse { + /** + * The list of examples. There will be a maximum number of items returned based on the page_size field in the request. + */ + examples?: Schema$GoogleCloudDialogflowCxV3Example[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + } /** * The response message for Experiments.ListExperiments. */ @@ -4298,6 +4478,32 @@ export namespace dialogflow_v3 { */ pages?: Schema$GoogleCloudDialogflowCxV3Page[]; } + /** + * The response message for Playbooks.ListPlaybooks. + */ + export interface Schema$GoogleCloudDialogflowCxV3ListPlaybooksResponse { + /** + * 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 playbooks. There will be a maximum number of items returned based on the page_size field in the request. + */ + playbooks?: Schema$GoogleCloudDialogflowCxV3Playbook[]; + } + /** + * The response message for Playbooks.ListPlaybookVersions. + */ + export interface Schema$GoogleCloudDialogflowCxV3ListPlaybookVersionsResponse { + /** + * 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 playbook version. There will be a maximum number of items returned based on the page_size field in the request. + */ + playbookVersions?: Schema$GoogleCloudDialogflowCxV3PlaybookVersion[]; + } /** * The response message for SecuritySettings.ListSecuritySettings. */ @@ -4350,6 +4556,19 @@ export namespace dialogflow_v3 { */ testCases?: Schema$GoogleCloudDialogflowCxV3TestCase[]; } + /** + * The response message for Tools.ListTools. + */ + export interface Schema$GoogleCloudDialogflowCxV3ListToolsResponse { + /** + * 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 Tools. There will be a maximum number of items returned based on the page_size field in the request. + */ + tools?: Schema$GoogleCloudDialogflowCxV3Tool[]; + } /** * The response message for TransitionRouteGroups.ListTransitionRouteGroups. */ @@ -4389,6 +4608,19 @@ export namespace dialogflow_v3 { */ webhooks?: Schema$GoogleCloudDialogflowCxV3Webhook[]; } + /** + * Settings for LLM models. + */ + export interface Schema$GoogleCloudDialogflowCxV3LlmModelSettings { + /** + * The selected LLM model. + */ + model?: string | null; + /** + * The custom prompt to use. + */ + promptText?: string | null; + } /** * The request message for Versions.LoadVersion. */ @@ -4625,6 +4857,166 @@ export namespace dialogflow_v3 { */ text?: string | null; } + /** + * Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. + */ + export interface Schema$GoogleCloudDialogflowCxV3Playbook { + /** + * Output only. The timestamp of initial playbook creation. + */ + createTime?: string | null; + /** + * Required. The human-readable name of the playbook, unique within an agent. + */ + displayName?: string | null; + /** + * 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; + /** + * Instruction to accomplish target goal. + */ + instruction?: Schema$GoogleCloudDialogflowCxV3PlaybookInstruction; + /** + * Optional. Llm model settings for the playbook. + */ + llmModelSettings?: Schema$GoogleCloudDialogflowCxV3LlmModelSettings; + /** + * The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + */ + name?: string | null; + /** + * Output only. The resource name of flows referenced by the current playbook in the instructions. + */ + referencedFlows?: string[] | null; + /** + * Output only. The resource name of other playbooks referenced by the current playbook in the instructions. + */ + referencedPlaybooks?: string[] | null; + /** + * Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps. + */ + referencedTools?: string[] | null; + /** + * Output only. Estimated number of tokes current playbook takes when sent to the LLM. + */ + tokenCount?: string | null; + /** + * Output only. Last time the playbook version was updated. + */ + updateTime?: string | null; + } + /** + * The playbook import strategy used for resource conflict resolution associated with an ImportPlaybookRequest. + */ + export interface Schema$GoogleCloudDialogflowCxV3PlaybookImportStrategy { + /** + * Optional. Specifies the import strategy used when resolving conflicts with the main playbook. If not specified, 'CREATE_NEW' is assumed. + */ + mainPlaybookImportStrategy?: string | null; + /** + * Optional. Specifies the import strategy used when resolving referenced playbook/flow conflicts. If not specified, 'CREATE_NEW' is assumed. + */ + nestedResourceImportStrategy?: string | null; + /** + * Optional. Specifies the import strategy used when resolving tool conflicts. If not specified, 'CREATE_NEW' is assumed. This will be applied after the main playbook and nested resource import strategies, meaning if the playbook that references the tool is skipped, the tool will also be skipped. + */ + toolImportStrategy?: string | null; + } + /** + * Input of the playbook. + */ + export interface Schema$GoogleCloudDialogflowCxV3PlaybookInput { + /** + * Optional. Summary string of the preceding conversation for the child playbook invocation. + */ + precedingConversationSummary?: string | null; + } + /** + * Message of the Instruction of the playbook. + */ + export interface Schema$GoogleCloudDialogflowCxV3PlaybookInstruction { + /** + * General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. + */ + guidelines?: string | null; + /** + * Ordered list of step by step execution instructions to accomplish target goal. + */ + steps?: Schema$GoogleCloudDialogflowCxV3PlaybookStep[]; + } + /** + * Stores metadata of the invocation of a child playbook. + */ + export interface Schema$GoogleCloudDialogflowCxV3PlaybookInvocation { + /** + * Output only. The display name of the playbook. + */ + displayName?: string | null; + /** + * Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + */ + playbook?: string | null; + /** + * Optional. Input of the child playbook invocation. + */ + playbookInput?: Schema$GoogleCloudDialogflowCxV3PlaybookInput; + /** + * Optional. Output of the child playbook invocation. + */ + playbookOutput?: Schema$GoogleCloudDialogflowCxV3PlaybookOutput; + /** + * Required. Playbook invocation's output state. + */ + playbookState?: string | null; + } + /** + * Output of the playbook. + */ + export interface Schema$GoogleCloudDialogflowCxV3PlaybookOutput { + /** + * Optional. Summary string of the execution result of the child playbook. + */ + executionSummary?: string | null; + } + /** + * Message of single step execution. + */ + export interface Schema$GoogleCloudDialogflowCxV3PlaybookStep { + /** + * Sub-processing needed to execute the current step. + */ + steps?: Schema$GoogleCloudDialogflowCxV3PlaybookStep[]; + /** + * Step instruction in text format. + */ + text?: string | null; + } + /** + * Playbook version is a snapshot of the playbook at certain timestamp. + */ + export interface Schema$GoogleCloudDialogflowCxV3PlaybookVersion { + /** + * Optional. The description of the playbook version. + */ + description?: string | null; + /** + * Output only. Snapshot of the examples belonging to the playbook when the playbook version is created. + */ + examples?: Schema$GoogleCloudDialogflowCxV3Example[]; + /** + * The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. + */ + name?: string | null; + /** + * Output only. Snapshot of the playbook when the playbook version is created. + */ + playbook?: Schema$GoogleCloudDialogflowCxV3Playbook; + /** + * Output only. Last time the playbook version was created or modified. + */ + updateTime?: string | null; + } /** * Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. */ @@ -4653,6 +5045,10 @@ export namespace dialogflow_v3 { * The natural language text to be processed. */ text?: Schema$GoogleCloudDialogflowCxV3TextInput; + /** + * The results of a tool executed by the client. + */ + toolCallResult?: Schema$GoogleCloudDialogflowCxV3ToolCallResult; } /** * Represents the parameters of a conversational query. @@ -4670,6 +5066,10 @@ export namespace dialogflow_v3 { * The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. */ currentPage?: string | null; + /** + * Optional. The unique identifier of the playbook to start or continue the session with. If `current_playbook` is specified, the previous state of the session will be ignored by Dialogflow. Format: `projects//locations//agents//playbooks/`. + */ + currentPlaybook?: string | null; /** * Whether to disable webhook calls for this request. */ @@ -4686,6 +5086,10 @@ export namespace dialogflow_v3 { * The geo location of this conversational query. */ geoLocation?: Schema$GoogleTypeLatLng; + /** + * Optional. Use the specified LLM model settings for processing the request. + */ + llmModelSettings?: Schema$GoogleCloudDialogflowCxV3LlmModelSettings; /** * Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. */ @@ -4865,6 +5269,10 @@ export namespace dialogflow_v3 { * Returns a text response. */ text?: Schema$GoogleCloudDialogflowCxV3ResponseMessageText; + /** + * Returns the definition of a tool call that should be executed by the client. + */ + toolCall?: Schema$GoogleCloudDialogflowCxV3ToolCall; } /** * Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. @@ -5000,6 +5408,19 @@ export namespace dialogflow_v3 { */ trackingBranch?: string | null; } + /** + * The request message for Playbooks.RestorePlaybookVersion. + */ + export interface Schema$GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest {} + /** + * The response message for Playbooks.RestorePlaybookVersion. + */ + export interface Schema$GoogleCloudDialogflowCxV3RestorePlaybookVersionResponse { + /** + * The updated playbook. + */ + playbook?: Schema$GoogleCloudDialogflowCxV3Playbook; + } /** * The configuration for auto rollout. */ @@ -5103,7 +5524,11 @@ export namespace dialogflow_v3 { * Banned phrases for generated text. */ bannedPhrases?: Schema$GoogleCloudDialogflowCxV3SafetySettingsPhrase[]; - } + /** + * Optional. Default phrase match strategy for banned phrases. + */ + defaultBannedPhraseMatchStrategy?: string | null; + } /** * Text input which can be used for prompt or banned phrases. */ @@ -5457,6 +5882,286 @@ export namespace dialogflow_v3 { [key: string]: Schema$GoogleCloudDialogflowCxV3SynthesizeSpeechConfig; } | null; } + /** + * 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$GoogleCloudDialogflowCxV3Tool { + /** + * Data store search tool specification. + */ + dataStoreSpec?: Schema$GoogleCloudDialogflowCxV3ToolDataStoreTool; + /** + * Required. High level description of the Tool and its usage. + */ + description?: string | null; + /** + * Required. The human-readable name of the Tool, unique within an agent. + */ + displayName?: string | null; + /** + * Client side executed function specification. + */ + functionSpec?: Schema$GoogleCloudDialogflowCxV3ToolFunctionTool; + /** + * The unique identifier of the Tool. Format: `projects//locations//agents//tools/`. + */ + name?: string | null; + /** + * OpenAPI specification of the Tool. + */ + openApiSpec?: Schema$GoogleCloudDialogflowCxV3ToolOpenApiTool; + /** + * Output only. The tool type. + */ + toolType?: string | null; + } + /** + * Authentication information required for API calls + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolAuthentication { + /** + * Config for API key auth. + */ + apiKeyConfig?: Schema$GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig; + /** + * Config for bearer token auth. + */ + bearerTokenConfig?: Schema$GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig; + /** + * Config for OAuth. + */ + oauthConfig?: Schema$GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig; + /** + * Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. + */ + serviceAgentAuthConfig?: Schema$GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig; + } + /** + * Config for authentication with API key. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig { + /** + * Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored. + */ + apiKey?: string | null; + /** + * Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + */ + keyName?: string | null; + /** + * Required. Key location in the request. + */ + requestLocation?: string | null; + /** + * Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForApiKey?: string | null; + } + /** + * Config for authentication using bearer token. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig { + /** + * Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForToken?: string | null; + /** + * Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. + */ + token?: string | null; + } + /** + * Config for authentication with OAuth. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig { + /** + * Required. The client ID from the OAuth provider. + */ + clientId?: string | null; + /** + * Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored. + */ + clientSecret?: string | null; + /** + * Required. OAuth grant types. + */ + oauthGrantType?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; + /** + * Required. The token endpoint in the OAuth provider to exchange for an access token. + */ + tokenEndpoint?: string | null; + } + /** + * Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig { + /** + * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. + */ + serviceAgentAuth?: string | null; + } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action that has been executed by the client. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowCxV3ToolCallResultError; + /** + * The tool call's output parameters. + */ + outputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } + /** + * A DataStoreTool is a way to provide specifications needed to search a list of data stores. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolDataStoreTool { + /** + * Required. List of data stores to search. + */ + dataStoreConnections?: Schema$GoogleCloudDialogflowCxV3DataStoreConnection[]; + /** + * Required. Fallback prompt configurations to use. + */ + fallbackPrompt?: Schema$GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt; + } + /** + * A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt {} + /** + * A Function tool describes the functions to be invoked on the client side. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolFunctionTool { + /** + * Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object. + */ + inputSchema?: {[key: string]: any} | null; + /** + * Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object. + */ + outputSchema?: {[key: string]: any} | null; + } + /** + * An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolOpenApiTool { + /** + * Optional. Authentication information required by the API. + */ + authentication?: Schema$GoogleCloudDialogflowCxV3ToolAuthentication; + /** + * Optional. Service Directory configuration. + */ + serviceDirectoryConfig?: Schema$GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig; + /** + * Required. The OpenAPI schema specified as a text. + */ + textSchema?: string | null; + /** + * Optional. TLS configuration for the HTTPS verification. + */ + tlsConfig?: Schema$GoogleCloudDialogflowCxV3ToolTLSConfig; + } + /** + * Configuration for tools using Service Directory. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig { + /** + * Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the agent. + */ + service?: string | null; + } + /** + * The TLS configuration. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolTLSConfig { + /** + * Required. Specifies a list of allowed custom CA certificates for HTTPS verification. + */ + caCerts?: Schema$GoogleCloudDialogflowCxV3ToolTLSConfigCACert[]; + } + /** + * The CA certificate. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolTLSConfigCACert { + /** + * 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; + /** + * Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. + */ + displayName?: string | null; + } + /** + * Stores metadata of the invocation of an action supported by a tool. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolUse { + /** + * Optional. Name of the action to be called during the tool use. + */ + action?: string | null; + /** + * Output only. The display name of the tool. + */ + displayName?: string | null; + /** + * Optional. A list of input parameters for the action. + */ + inputActionParameters?: {[key: string]: any} | null; + /** + * Optional. A list of output parameters generated by the action. + */ + outputActionParameters?: {[key: string]: any} | null; + /** + * Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } /** * The request message for Flows.TrainFlow. */ @@ -5654,6 +6359,15 @@ export namespace dialogflow_v3 { */ webhookStatuses?: string[] | null; } + /** + * UserUtterance represents one message sent by the customer. + */ + export interface Schema$GoogleCloudDialogflowCxV3UserUtterance { + /** + * Required. Message content in text. + */ + text?: string | null; + } /** * The request message for Agents.ValidateAgent. */ @@ -5839,6 +6553,18 @@ export namespace dialogflow_v3 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -5872,11 +6598,24 @@ export namespace dialogflow_v3 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -6453,6 +7192,23 @@ export namespace dialogflow_v3 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2beta1ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2beta1ToolCallResult; } /** * Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation. @@ -8041,60 +8797,119 @@ export namespace dialogflow_v3 { dtmfEvents?: string[] | null; } /** - * The request message for a webhook call. + * Represents a call of a specific tool's action with the specified inputs. */ - export interface Schema$GoogleCloudDialogflowV2beta1WebhookRequest { - /** - * Alternative query results from KnowledgeService. - */ - alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; + export interface Schema$GoogleCloudDialogflowV2beta1ToolCall { /** - * Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call. + * Required. The name of the tool's action associated with this call. */ - originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest; + action?: string | null; /** - * The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`. + * Output only. Create time of the tool call. */ - queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; + createTime?: string | null; /** - * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. + * Optional. The action's input parameters. */ - responseId?: string | null; + inputParameters?: {[key: string]: any} | null; /** - * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, + * Required. The tool associated with this call. Format: `projects//locations//tools/`. */ - session?: string | null; + tool?: string | null; } /** - * The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `""` for empty strings - Use `{\}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + * The result of calling a tool's action. */ - export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse { + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResult { /** - * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. + * Required. The name of the tool's action associated with this call. */ - endInteraction?: boolean | null; + action?: string | null; /** - * Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. + * Only populated if the response content is utf-8 encoded. */ - followupEventInput?: Schema$GoogleCloudDialogflowV2beta1EventInput; + content?: string | null; /** - * Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller. + * Output only. Create time of the tool call result. */ - fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; + createTime?: string | null; /** - * Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller. + * The tool call's error. */ - fulfillmentText?: string | null; + error?: Schema$GoogleCloudDialogflowV2beta1ToolCallResultError; /** - * Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false. + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). */ - liveAgentHandoff?: boolean | null; + rawContent?: string | null; /** - * Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller. + * Required. The tool associated with this call. Format: `projects//locations//tools/`. */ - outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; - /** - * Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } + /** + * The request message for a webhook call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1WebhookRequest { + /** + * Alternative query results from KnowledgeService. + */ + alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; + /** + * Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call. + */ + originalDetectIntentRequest?: Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest; + /** + * The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`. + */ + queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; + /** + * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. + */ + responseId?: string | null; + /** + * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, + */ + session?: string | null; + } + /** + * The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `""` for empty strings - Use `{\}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + */ + export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse { + /** + * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. + */ + endInteraction?: boolean | null; + /** + * Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. + */ + followupEventInput?: Schema$GoogleCloudDialogflowV2beta1EventInput; + /** + * Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller. + */ + fulfillmentMessages?: Schema$GoogleCloudDialogflowV2beta1IntentMessage[]; + /** + * Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller. + */ + fulfillmentText?: string | null; + /** + * Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false. + */ + liveAgentHandoff?: boolean | null; + /** + * Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller. + */ + outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; + /** + * Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) */ payload?: {[key: string]: any} | null; /** @@ -8474,6 +9289,23 @@ export namespace dialogflow_v3 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2ToolCallResult; } /** * Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation. @@ -9705,6 +10537,65 @@ export namespace dialogflow_v3 { */ summary?: string | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Output only. Create time of the tool call. + */ + createTime?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Only populated if the response content is utf-8 encoded. + */ + content?: string | null; + /** + * Output only. Create time of the tool call result. + */ + createTime?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowV2ToolCallResultError; + /** + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). + */ + rawContent?: string | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * Metadata for a ConversationModels.UndeployConversationModel operation. */ @@ -10167,6 +11058,10 @@ export namespace dialogflow_v3 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -10193,8 +11088,10 @@ export namespace dialogflow_v3 { flows: Resource$Projects$Locations$Agents$Flows; generators: Resource$Projects$Locations$Agents$Generators; intents: Resource$Projects$Locations$Agents$Intents; + playbooks: Resource$Projects$Locations$Agents$Playbooks; sessions: Resource$Projects$Locations$Agents$Sessions; testCases: Resource$Projects$Locations$Agents$Testcases; + tools: Resource$Projects$Locations$Agents$Tools; transitionRouteGroups: Resource$Projects$Locations$Agents$Transitionroutegroups; webhooks: Resource$Projects$Locations$Agents$Webhooks; constructor(context: APIRequestContext) { @@ -10215,12 +11112,16 @@ export namespace dialogflow_v3 { this.intents = new Resource$Projects$Locations$Agents$Intents( this.context ); + this.playbooks = new Resource$Projects$Locations$Agents$Playbooks( + this.context + ); this.sessions = new Resource$Projects$Locations$Agents$Sessions( this.context ); this.testCases = new Resource$Projects$Locations$Agents$Testcases( this.context ); + this.tools = new Resource$Projects$Locations$Agents$Tools(this.context); this.transitionRouteGroups = new Resource$Projects$Locations$Agents$Transitionroutegroups( this.context @@ -19678,77 +20579,80 @@ export namespace dialogflow_v3 { requestBody?: Schema$GoogleCloudDialogflowCxV3Intent; } - export class Resource$Projects$Locations$Agents$Sessions { + export class Resource$Projects$Locations$Agents$Playbooks { context: APIRequestContext; - entityTypes: Resource$Projects$Locations$Agents$Sessions$Entitytypes; + examples: Resource$Projects$Locations$Agents$Playbooks$Examples; + versions: Resource$Projects$Locations$Agents$Playbooks$Versions; constructor(context: APIRequestContext) { this.context = context; - this.entityTypes = - new Resource$Projects$Locations$Agents$Sessions$Entitytypes( - this.context - ); + this.examples = new Resource$Projects$Locations$Agents$Playbooks$Examples( + this.context + ); + this.versions = new Resource$Projects$Locations$Agents$Playbooks$Versions( + this.context + ); } /** - * Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). + * Creates a playbook in a specified agent. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - detectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Create, options: StreamMethodOptions ): GaxiosPromise; - detectIntent( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + create( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Create, options?: MethodOptions - ): GaxiosPromise; - detectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - detectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - detectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Create, + callback: BodyResponseCallback ): void; - detectIntent( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - detectIntent( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Detectintent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$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$Agents$Sessions$Detectintent; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Detectintent; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Create; options = {}; } @@ -19761,7 +20665,7 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+session}:detectIntent').replace( + url: (rootUrl + '/v3/{+parent}/playbooks').replace( /([^:]\/)\/+/g, '$1' ), @@ -19771,82 +20675,78 @@ export namespace dialogflow_v3 { options ), params, - requiredParams: ['session'], - pathParams: ['session'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined. + * Deletes a specified playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fulfillIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Delete, options: StreamMethodOptions ): GaxiosPromise; - fulfillIntent( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + delete( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Delete, options?: MethodOptions - ): GaxiosPromise; - fulfillIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fulfillIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - fulfillIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fulfillIntent( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Delete, + callback: BodyResponseCallback ): void; - fulfillIntent( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$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$Agents$Sessions$Fulfillintent; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Delete; options = {}; } @@ -19859,92 +20759,87 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+session}:fulfillIntent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['session'], - pathParams: ['session'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns preliminary intent match results, doesn't change the session status. + * Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - matchIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, options: StreamMethodOptions ): GaxiosPromise; - matchIntent( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + export( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Export, options?: MethodOptions - ): GaxiosPromise; - matchIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - matchIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - matchIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, - callback: BodyResponseCallback + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, + callback: BodyResponseCallback ): void; - matchIntent( - callback: BodyResponseCallback + export( + callback: BodyResponseCallback ): void; - matchIntent( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Matchintent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Export + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Agents$Sessions$Matchintent; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Matchintent; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Export; options = {}; } @@ -19957,92 +20852,86 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+session}:matchIntent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v3/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['session'], - pathParams: ['session'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request. + * Retrieves the specified Playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - serverStreamingDetectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Get, options: StreamMethodOptions ): GaxiosPromise; - serverStreamingDetectIntent( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + get( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Get, options?: MethodOptions - ): GaxiosPromise; - serverStreamingDetectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - serverStreamingDetectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - serverStreamingDetectIntent( - params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Get, + callback: BodyResponseCallback ): void; - serverStreamingDetectIntent( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - serverStreamingDetectIntent( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$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$Agents$Sessions$Serverstreamingdetectintent; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent; + params = {} as Params$Resource$Projects$Locations$Agents$Playbooks$Get; options = {}; } @@ -20055,91 +20944,89 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v3/{+session}:serverStreamingDetectIntent' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['session'], - pathParams: ['session'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the feedback received from the user for a single turn of the bot response. + * Imports the specified playbook to the specified agent from a binary file. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - submitAnswerFeedback( - params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + import( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Import, options: StreamMethodOptions ): GaxiosPromise; - submitAnswerFeedback( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + import( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Import, options?: MethodOptions - ): GaxiosPromise; - submitAnswerFeedback( - params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - submitAnswerFeedback( - params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + import( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - submitAnswerFeedback( - params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Import, + callback: BodyResponseCallback ): void; - submitAnswerFeedback( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - submitAnswerFeedback( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$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$Agents$Sessions$Submitanswerfeedback; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Import; options = {}; } @@ -20152,7 +21039,7 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+session}:submitAnswerFeedback').replace( + url: (rootUrl + '/v3/{+parent}/playbooks:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -20162,150 +21049,79 @@ export namespace dialogflow_v3 { options ), params, - requiredParams: ['session'], - pathParams: ['session'], + 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$Agents$Sessions$Detectintent - extends StandardParameters { - /** - * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). - */ - session?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3DetectIntentRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent - extends StandardParameters { - /** - * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). - */ - session?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3FulfillIntentRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Matchintent - extends StandardParameters { - /** - * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). - */ - session?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3MatchIntentRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent - extends StandardParameters { - /** - * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). - */ - session?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3DetectIntentRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback - extends StandardParameters { - /** - * Required. The name of the session the feedback was sent to. - */ - session?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest; - } - - export class Resource$Projects$Locations$Agents$Sessions$Entitytypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a session entity type. + * Returns a list of playbooks in the specified agent. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Sessions$Entitytypes$Create, + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + list( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$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$Agents$Sessions$Entitytypes$Create; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create; + params = {} as Params$Resource$Projects$Locations$Agents$Playbooks$List; options = {}; } @@ -20318,11 +21134,11 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/entityTypes').replace( + url: (rootUrl + '/v3/{+parent}/playbooks').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -20333,73 +21149,77 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes the specified session entity type. + * Updates the specified Playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Sessions$Entitytypes$Delete, + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, + patch( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$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$Agents$Sessions$Entitytypes$Delete; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Patch; options = {}; } @@ -20413,7 +21233,7 @@ export namespace dialogflow_v3 { options: Object.assign( { url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -20424,75 +21244,166 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Create + extends StandardParameters { /** - * Retrieves the specified session entity type. + * Required. The agent to create a playbook for. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3Playbook; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Delete + extends StandardParameters { + /** + * Required. The name of the playbook to delete. Format: `projects//locations//agents//playbooks/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Export + extends StandardParameters { + /** + * Required. The name of the playbook to export. Format: `projects//locations//agents//playbooks/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3ExportPlaybookRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Get + extends StandardParameters { + /** + * Required. The name of the playbook. Format: `projects//locations//agents//playbooks/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Import + extends StandardParameters { + /** + * Required. The agent to import the playbook into. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3ImportPlaybookRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$List + extends StandardParameters { + /** + * The maximum number of items to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The agent to list playbooks from. Format: `projects//locations//agents/`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Patch + extends StandardParameters { + /** + * The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + */ + name?: string; + /** + * The mask to control which fields get updated. If the mask is not present, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3Playbook; + } + + export class Resource$Projects$Locations$Agents$Playbooks$Examples { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an example in the specified playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Sessions$Entitytypes$Get, + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, + create( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Examples$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$Agents$Sessions$Entitytypes$Get; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Create; options = {}; } @@ -20505,89 +21416,88 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v3/{+parent}/examples').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 ); } } /** - * Returns the list of all session entity types in the specified session. + * Deletes the specified example. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Sessions$Entitytypes$List, + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, + delete( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Examples$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$Agents$Sessions$Entitytypes$List; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete; options = {}; } @@ -20600,92 +21510,87 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/entityTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the specified session entity type. + * Retrieves the specified example. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Sessions$Entitytypes$Patch, + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + get( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Examples$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$Agents$Sessions$Entitytypes$Patch; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get; options = {}; } @@ -20699,7 +21604,7 @@ export namespace dialogflow_v3 { options: Object.assign( { url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -20710,144 +21615,77 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create - extends StandardParameters { - /** - * Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3SessionEntityType; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete - extends StandardParameters { /** - * Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. + * Returns a list of examples in the specified playbook. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get - extends StandardParameters { - /** - * Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List - extends StandardParameters { - /** - * The maximum number of items to return in a single page. By default 100 and at most 1000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous list request. - */ - pageToken?: string; - /** - * Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch - extends StandardParameters { - /** - * Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. - */ - name?: string; - /** - * The mask to control which fields get updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3SessionEntityType; - } - - export class Resource$Projects$Locations$Agents$Testcases { - context: APIRequestContext; - results: Resource$Projects$Locations$Agents$Testcases$Results; - constructor(context: APIRequestContext) { - this.context = context; - this.results = new Resource$Projects$Locations$Agents$Testcases$Results( - this.context - ); - } - - /** - * Batch deletes 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$Locations$Agents$Testcases$Batchdelete, + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List, options: StreamMethodOptions ): GaxiosPromise; - batchDelete( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, + list( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List, options?: MethodOptions - ): GaxiosPromise; - batchDelete( - params: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List, + callback: BodyResponseCallback ): void; - batchDelete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchDelete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Examples$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$Agents$Testcases$Batchdelete; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List; options = {}; } @@ -20860,11 +21698,11 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/testCases:batchDelete').replace( + url: (rootUrl + '/v3/{+parent}/examples').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -20875,75 +21713,77 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Kicks off a batch run of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse + * Update the specified example. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchRun( - params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch, options: StreamMethodOptions ): GaxiosPromise; - batchRun( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + patch( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch, options?: MethodOptions - ): GaxiosPromise; - batchRun( - params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchRun( - params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchRun( - params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch, + callback: BodyResponseCallback ): void; - batchRun( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - batchRun( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Batchrun - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Examples$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$Agents$Testcases$Batchrun; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Batchrun; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch; options = {}; } @@ -20956,90 +21796,158 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/testCases:batchRun').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v3/{+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$Agents$Playbooks$Examples$Create + extends StandardParameters { + /** + * Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`. + */ + parent?: string; /** - * Calculates the test coverage for an agent. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3Example; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Delete + extends StandardParameters { + /** + * Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Get + extends StandardParameters { + /** + * Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List + extends StandardParameters { + /** + * Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used. + */ + languageCode?: string; + /** + * 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 playbook to list the examples from. Format: `projects//locations//agents//playbooks/`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Examples$Patch + extends StandardParameters { + /** + * The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + */ + name?: string; + /** + * Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3Example; + } + + export class Resource$Projects$Locations$Agents$Playbooks$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a version for the specified Playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - calculateCoverage( - params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create, options: StreamMethodOptions ): GaxiosPromise; - calculateCoverage( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + create( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create, options?: MethodOptions - ): GaxiosPromise; - calculateCoverage( - params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - calculateCoverage( - params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - calculateCoverage( - params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create, + callback: BodyResponseCallback ): void; - calculateCoverage( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - calculateCoverage( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Versions$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$Agents$Testcases$Calculatecoverage; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create; options = {}; } @@ -21052,190 +21960,88 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+agent}/testCases:calculateCoverage').replace( + url: (rootUrl + '/v3/{+parent}/versions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['agent'], - pathParams: ['agent'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a test case for the given agent. + * Deletes the specified version of the Playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Testcases$Create, + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Create, + delete( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Agents$Testcases$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Agents$Testcases$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Agents$Testcases$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Agents$Testcases$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+parent}/testCases').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 - ); - } - } - - /** - * Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportTestCasesMetadata - `response`: ExportTestCasesResponse - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - export( - params: Params$Resource$Projects$Locations$Agents$Testcases$Export, - options: StreamMethodOptions - ): GaxiosPromise; - export( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Export, - options?: MethodOptions - ): GaxiosPromise; - export( - params: Params$Resource$Projects$Locations$Agents$Testcases$Export, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - export( - params: Params$Resource$Projects$Locations$Agents$Testcases$Export, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - export( - params: Params$Resource$Projects$Locations$Agents$Testcases$Export, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - export( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete, + callback: BodyResponseCallback ): void; - export( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Export - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Versions$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$Agents$Testcases$Export; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Export; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete; options = {}; } @@ -21248,32 +22054,29 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/testCases:export').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v3/{+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 test case. + * Retrieves the specified version of the Playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21281,56 +22084,57 @@ export namespace dialogflow_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Get, + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Get, + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Get, + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Get, + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Versions$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$Agents$Testcases$Get; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Agents$Testcases$Get; + params = + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get; options = {}; } @@ -21355,77 +22159,77 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse + * Lists versions for the specified Playbook. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Testcases$Import, + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Import, + list( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Agents$Testcases$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Agents$Testcases$Import, + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Agents$Testcases$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Versions$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$Agents$Testcases$Import; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Import; + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$List; options = {}; } @@ -21438,11 +22242,11 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/testCases:import').replace( + url: (rootUrl + '/v3/{+parent}/versions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -21453,74 +22257,77 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Fetches a list of test cases for a given agent. + * Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook 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. */ - list( - params: Params$Resource$Projects$Locations$Agents$Testcases$List, + restore( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Agents$Testcases$List, + restore( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Agents$Testcases$List, + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Agents$Testcases$List, + restore( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Agents$Testcases$List, - callback: BodyResponseCallback + restore( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + restore( + callback: BodyResponseCallback ): void; - list( + restore( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Agents$Testcases$List; + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Agents$Testcases$List; + params = + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore; options = {}; } @@ -21533,92 +22340,2348 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/testCases').replace( + url: (rootUrl + '/v3/{+name}:restore').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Create + extends StandardParameters { /** - * Updates the specified test case. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`. */ - patch( - params: Params$Resource$Projects$Locations$Agents$Testcases$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Patch, - options?: MethodOptions + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3PlaybookVersion; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Delete + extends StandardParameters { + /** + * Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Get + extends StandardParameters { + /** + * Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$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 playbook to list versions for. Format: `projects//locations//agents//playbooks/`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore + extends StandardParameters { + /** + * Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest; + } + + export class Resource$Projects$Locations$Agents$Sessions { + context: APIRequestContext; + entityTypes: Resource$Projects$Locations$Agents$Sessions$Entitytypes; + constructor(context: APIRequestContext) { + this.context = context; + this.entityTypes = + new Resource$Projects$Locations$Agents$Sessions$Entitytypes( + this.context + ); + } + + /** + * Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/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. + */ + detectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + options: StreamMethodOptions + ): GaxiosPromise; + detectIntent( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + options?: MethodOptions + ): GaxiosPromise; + detectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Detectintent, + callback: BodyResponseCallback + ): void; + detectIntent( + callback: BodyResponseCallback + ): void; + detectIntent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Detectintent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Detectintent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Detectintent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+session}:detectIntent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['session'], + pathParams: ['session'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fulfillIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + options: StreamMethodOptions + ): GaxiosPromise; + fulfillIntent( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + options?: MethodOptions + ): GaxiosPromise; + fulfillIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fulfillIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fulfillIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent, + callback: BodyResponseCallback + ): void; + fulfillIntent( + callback: BodyResponseCallback + ): void; + fulfillIntent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+session}:fulfillIntent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['session'], + pathParams: ['session'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns preliminary intent match results, doesn't change the session status. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + matchIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + options: StreamMethodOptions + ): GaxiosPromise; + matchIntent( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + options?: MethodOptions + ): GaxiosPromise; + matchIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + matchIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + matchIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Matchintent, + callback: BodyResponseCallback + ): void; + matchIntent( + callback: BodyResponseCallback + ): void; + matchIntent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Matchintent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Matchintent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Matchintent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+session}:matchIntent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['session'], + pathParams: ['session'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single 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. + */ + serverStreamingDetectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + options: StreamMethodOptions + ): GaxiosPromise; + serverStreamingDetectIntent( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + options?: MethodOptions + ): GaxiosPromise; + serverStreamingDetectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + serverStreamingDetectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + serverStreamingDetectIntent( + params: Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent, + callback: BodyResponseCallback + ): void; + serverStreamingDetectIntent( + callback: BodyResponseCallback + ): void; + serverStreamingDetectIntent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/{+session}:serverStreamingDetectIntent' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['session'], + pathParams: ['session'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the feedback received from the user for a single turn of the bot 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. + */ + submitAnswerFeedback( + params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + options: StreamMethodOptions + ): GaxiosPromise; + submitAnswerFeedback( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + options?: MethodOptions + ): GaxiosPromise; + submitAnswerFeedback( + params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + submitAnswerFeedback( + params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + submitAnswerFeedback( + params: Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback, + callback: BodyResponseCallback + ): void; + submitAnswerFeedback( + callback: BodyResponseCallback + ): void; + submitAnswerFeedback( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+session}:submitAnswerFeedback').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['session'], + pathParams: ['session'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Agents$Sessions$Detectintent + extends StandardParameters { + /** + * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). + */ + session?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3DetectIntentRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Fulfillintent + extends StandardParameters { + /** + * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). + */ + session?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3FulfillIntentRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Matchintent + extends StandardParameters { + /** + * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). + */ + session?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3MatchIntentRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Serverstreamingdetectintent + extends StandardParameters { + /** + * Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). + */ + session?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3DetectIntentRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Submitanswerfeedback + extends StandardParameters { + /** + * Required. The name of the session the feedback was sent to. + */ + session?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest; + } + + export class Resource$Projects$Locations$Agents$Sessions$Entitytypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a session entity 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. + */ + create( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/entityTypes').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 session entity 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. + */ + delete( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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 session entity 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$Projects$Locations$Agents$Sessions$Entitytypes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.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 + ); + } + } + + /** + * Returns the list of all session entity types in the specified session. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/entityTypes').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 session entity 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. + */ + patch( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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$Agents$Sessions$Entitytypes$Create + extends StandardParameters { + /** + * Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3SessionEntityType; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Delete + extends StandardParameters { + /** + * Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Get + extends StandardParameters { + /** + * Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$List + extends StandardParameters { + /** + * The maximum number of items to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Sessions$Entitytypes$Patch + extends StandardParameters { + /** + * Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. + */ + name?: string; + /** + * The mask to control which fields get updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3SessionEntityType; + } + + export class Resource$Projects$Locations$Agents$Testcases { + context: APIRequestContext; + results: Resource$Projects$Locations$Agents$Testcases$Results; + constructor(context: APIRequestContext) { + this.context = context; + this.results = new Resource$Projects$Locations$Agents$Testcases$Results( + this.context + ); + } + + /** + * Batch deletes 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$Locations$Agents$Testcases$Batchdelete, + options: StreamMethodOptions + ): GaxiosPromise; + batchDelete( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, + options?: MethodOptions + ): GaxiosPromise; + batchDelete( + params: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete( + callback: BodyResponseCallback + ): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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); + } + } + + /** + * Kicks off a batch run of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchRun( + params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + options: StreamMethodOptions + ): GaxiosPromise; + batchRun( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + options?: MethodOptions + ): GaxiosPromise; + batchRun( + params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchRun( + params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchRun( + params: Params$Resource$Projects$Locations$Agents$Testcases$Batchrun, + callback: BodyResponseCallback + ): void; + batchRun( + callback: BodyResponseCallback + ): void; + batchRun( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Batchrun + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Batchrun; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Batchrun; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/testCases:batchRun').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); + } + } + + /** + * Calculates the test coverage for an agent. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + calculateCoverage( + params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + options: StreamMethodOptions + ): GaxiosPromise; + calculateCoverage( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + options?: MethodOptions + ): GaxiosPromise; + calculateCoverage( + params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateCoverage( + params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateCoverage( + params: Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage, + callback: BodyResponseCallback + ): void; + calculateCoverage( + callback: BodyResponseCallback + ): void; + calculateCoverage( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+agent}/testCases:calculateCoverage').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['agent'], + pathParams: ['agent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a test case for the given agent. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Testcases$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Agents$Testcases$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Testcases$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Testcases$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/testCases').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 + ); + } + } + + /** + * Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportTestCasesMetadata - `response`: ExportTestCasesResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Agents$Testcases$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Agents$Testcases$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Testcases$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Testcases$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/testCases:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a test case. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Testcases$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Agents$Testcases$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agents$Testcases$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agents$Testcases$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Testcases$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.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 + ); + } + } + + /** + * Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Testcases$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Agents$Testcases$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Testcases$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Testcases$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/testCases:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a list of test cases for a given agent. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Testcases$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Agents$Testcases$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Agents$Testcases$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agents$Testcases$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agents$Testcases$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Testcases$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/testCases').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 test case. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Testcases$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Patch, + options?: MethodOptions ): GaxiosPromise; patch( params: Params$Resource$Projects$Locations$Agents$Testcases$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Agents$Testcases$Patch, + patch( + params: Params$Resource$Projects$Locations$Agents$Testcases$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agents$Testcases$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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 + ); + } + } + + /** + * Kicks off a test case run. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + run( + params: Params$Resource$Projects$Locations$Agents$Testcases$Run, + options: StreamMethodOptions + ): GaxiosPromise; + run( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Agents$Testcases$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Agents$Testcases$Run, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Agents$Testcases$Patch, - callback: BodyResponseCallback + run( + params: Params$Resource$Projects$Locations$Agents$Testcases$Run, + callback: BodyResponseCallback + ): void; + run( + callback: BodyResponseCallback + ): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Testcases$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Testcases$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Agents$Testcases$Batchdelete + extends StandardParameters { + /** + * Required. The agent to delete test cases from. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Batchrun + extends StandardParameters { + /** + * Required. Agent name. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3BatchRunTestCasesRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage + extends StandardParameters { + /** + * Required. The agent to calculate coverage for. Format: `projects//locations//agents/`. + */ + agent?: string; + /** + * Required. The type of coverage requested. + */ + type?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Create + extends StandardParameters { + /** + * Required. The agent to create the test case for. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3TestCase; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Export + extends StandardParameters { + /** + * Required. The agent where to export test cases from. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3ExportTestCasesRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Get + extends StandardParameters { + /** + * Required. The name of the testcase. Format: `projects//locations//agents//testCases/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Import + extends StandardParameters { + /** + * Required. The agent to import test cases to. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3ImportTestCasesRequest; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$List + extends StandardParameters { + /** + * The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The agent to list all pages for. Format: `projects//locations//agents/`. + */ + parent?: string; + /** + * Specifies whether response should include all fields or just the metadata. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Patch + extends StandardParameters { + /** + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. + */ + name?: string; + /** + * Required. The mask to specify which fields should be updated. The `creationTime` and `lastTestResult` cannot be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3TestCase; + } + export interface Params$Resource$Projects$Locations$Agents$Testcases$Run + extends StandardParameters { + /** + * Required. Format of test case name to run: `projects//locations//agents//testCases/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3RunTestCaseRequest; + } + + export class Resource$Projects$Locations$Agents$Testcases$Results { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a test case result. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Testcases$Results$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + callback: BodyResponseCallback ): void; - patch( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Testcases$Results$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$Agents$Testcases$Patch; + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Results$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Patch; + {} as Params$Resource$Projects$Locations$Agents$Testcases$Results$Get; options = {}; } @@ -21632,7 +24695,7 @@ export namespace dialogflow_v3 { options: Object.assign( { url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -21643,76 +24706,77 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Kicks off a test case run. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse + * Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - run( - params: Params$Resource$Projects$Locations$Agents$Testcases$Run, + list( + params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, options: StreamMethodOptions ): GaxiosPromise; - run( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Run, + list( + params?: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, options?: MethodOptions - ): GaxiosPromise; - run( - params: Params$Resource$Projects$Locations$Agents$Testcases$Run, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Agents$Testcases$Run, + list( + params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Agents$Testcases$Run, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, + callback: BodyResponseCallback ): void; - run( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - run( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Run - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Testcases$Results$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$Agents$Testcases$Run; + {}) as Params$Resource$Projects$Locations$Agents$Testcases$Results$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Agents$Testcases$Run; + params = + {} as Params$Resource$Projects$Locations$Agents$Testcases$Results$List; options = {}; } @@ -21725,110 +24789,48 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v3/{+parent}/results').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$Agents$Testcases$Batchdelete - extends StandardParameters { - /** - * Required. The agent to delete test cases from. Format: `projects//locations//agents/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Batchrun - extends StandardParameters { - /** - * Required. Agent name. Format: `projects//locations//agents/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3BatchRunTestCasesRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Calculatecoverage - extends StandardParameters { - /** - * Required. The agent to calculate coverage for. Format: `projects//locations//agents/`. - */ - agent?: string; - /** - * Required. The type of coverage requested. - */ - type?: string; - } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Create - extends StandardParameters { - /** - * Required. The agent to create the test case for. Format: `projects//locations//agents/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3TestCase; - } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Export - extends StandardParameters { - /** - * Required. The agent where to export test cases from. Format: `projects//locations//agents/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3ExportTestCasesRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Get + export interface Params$Resource$Projects$Locations$Agents$Testcases$Results$Get extends StandardParameters { /** - * Required. The name of the testcase. Format: `projects//locations//agents//testCases/`. + * Required. The name of the testcase. Format: `projects//locations//agents//testCases//results/`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Import + export interface Params$Resource$Projects$Locations$Agents$Testcases$Results$List extends StandardParameters { /** - * Required. The agent to import test cases to. Format: `projects//locations//agents/`. - */ - parent?: string; - - /** - * Request body metadata + * The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `\>`, `<` `latest` only returns the latest test result in all results for each test case. Examples: * "environment=draft AND latest" matches the latest test result for each test case in the draft environment. * "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2". * "test_time \> 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713. */ - requestBody?: Schema$GoogleCloudDialogflowCxV3ImportTestCasesRequest; - } - export interface Params$Resource$Projects$Locations$Agents$Testcases$List - extends StandardParameters { + filter?: string; /** - * The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500. + * The maximum number of items to return in a single page. By default 100 and at most 1000. */ pageSize?: number; /** @@ -21836,51 +24838,204 @@ export namespace dialogflow_v3 { */ pageToken?: string; /** - * Required. The agent to list all pages for. Format: `projects//locations//agents/`. + * Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. */ parent?: string; - /** - * Specifies whether response should include all fields or just the metadata. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Patch - extends StandardParameters { - /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. - */ - name?: string; + + export class Resource$Projects$Locations$Agents$Tools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Required. The mask to specify which fields should be updated. The `creationTime` and `lastTestResult` cannot be updated. + * Creates a Tool in the specified agent. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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; + create( + params: Params$Resource$Projects$Locations$Agents$Tools$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Agents$Tools$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Agents$Tools$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Tools$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Tools$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Tools$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/tools').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 + ); + } + } /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3TestCase; - } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Run - extends StandardParameters { - /** - * Required. Format of test case name to run: `projects//locations//agents//testCases/`. + * Deletes a 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. */ - name?: string; + delete( + params: Params$Resource$Projects$Locations$Agents$Tools$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Agents$Tools$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Agents$Tools$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agents$Tools$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agents$Tools$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowCxV3RunTestCaseRequest; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Tools$Delete; + options = {}; + } - export class Resource$Projects$Locations$Agents$Testcases$Results { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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 test case result. + * Retrieves the specified Tool. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21888,57 +25043,56 @@ export namespace dialogflow_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + params: Params$Resource$Projects$Locations$Agents$Tools$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + params?: Params$Resource$Projects$Locations$Agents$Tools$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + params: Params$Resource$Projects$Locations$Agents$Tools$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, + params: Params$Resource$Projects$Locations$Agents$Tools$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Agents$Tools$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Results$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Tools$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$Agents$Testcases$Results$Get; + {}) as Params$Resource$Projects$Locations$Agents$Tools$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Results$Get; + params = {} as Params$Resource$Projects$Locations$Agents$Tools$Get; options = {}; } @@ -21963,19 +25117,19 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case. + * Returns a list of Tools in the specified agent. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21983,57 +25137,56 @@ export namespace dialogflow_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, + params: Params$Resource$Projects$Locations$Agents$Tools$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, + params?: Params$Resource$Projects$Locations$Agents$Tools$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, + params: Params$Resource$Projects$Locations$Agents$Tools$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, + params: Params$Resource$Projects$Locations$Agents$Tools$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Agents$Testcases$Results$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Agents$Tools$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Agents$Testcases$Results$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Tools$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$Agents$Testcases$Results$List; + {}) as Params$Resource$Projects$Locations$Agents$Tools$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Agents$Testcases$Results$List; + params = {} as Params$Resource$Projects$Locations$Agents$Tools$List; options = {}; } @@ -22046,7 +25199,7 @@ export namespace dialogflow_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/results').replace( + url: (rootUrl + '/v3/{+parent}/tools').replace( /([^:]\/)\/+/g, '$1' ), @@ -22061,31 +25214,144 @@ export namespace dialogflow_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( + parameters + ); + } + } + + /** + * Update 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. + */ + patch( + params: Params$Resource$Projects$Locations$Agents$Tools$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Agents$Tools$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Agents$Tools$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agents$Tools$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agents$Tools$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Tools$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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$Agents$Testcases$Results$Get + export interface Params$Resource$Projects$Locations$Agents$Tools$Create extends StandardParameters { /** - * Required. The name of the testcase. Format: `projects//locations//agents//testCases//results/`. + * Required. The agent to create a Tool for. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3Tool; + } + export interface Params$Resource$Projects$Locations$Agents$Tools$Delete + extends StandardParameters { + /** + * 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 to be deleted. Format: `projects//locations//agents//tools/`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Agents$Testcases$Results$List + export interface Params$Resource$Projects$Locations$Agents$Tools$Get extends StandardParameters { /** - * The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `\>`, `<` `latest` only returns the latest test result in all results for each test case. Examples: * "environment=draft AND latest" matches the latest test result for each test case in the draft environment. * "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2". * "test_time \> 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713. + * Required. The name of the Tool. Format: `projects//locations//agents//tools/`. */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Tools$List + extends StandardParameters { /** * The maximum number of items to return in a single page. By default 100 and at most 1000. */ @@ -22095,10 +25361,26 @@ export namespace dialogflow_v3 { */ pageToken?: string; /** - * Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. + * Required. The agent to list the Tools from. Format: `projects//locations//agents/`. */ parent?: string; } + export interface Params$Resource$Projects$Locations$Agents$Tools$Patch + extends StandardParameters { + /** + * The unique identifier of the Tool. Format: `projects//locations//agents//tools/`. + */ + name?: string; + /** + * The mask to control which fields get updated. If the mask is not present, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3Tool; + } export class Resource$Projects$Locations$Agents$Transitionroutegroups { context: APIRequestContext; diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 47103058f81..b5f754f7973 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -260,6 +260,14 @@ export namespace dialogflow_v3beta1 { * Optional. Action performed by the agent as a message. */ agentUtterance?: Schema$GoogleCloudDialogflowCxV3beta1AgentUtterance; + /** + * Output only. Timestamp of the completion of the agent action. + */ + completeTime?: string | null; + /** + * Output only. The display name of the action. + */ + displayName?: string | null; /** * Optional. The agent received an event from the customer or a system event is emitted. */ @@ -268,10 +276,22 @@ export namespace dialogflow_v3beta1 { * Optional. Action performed on behalf of the agent by invoking a CX flow. */ flowInvocation?: Schema$GoogleCloudDialogflowCxV3beta1FlowInvocation; + /** + * Optional. Output only. The state machine update in flows. + */ + flowStateUpdate?: Schema$GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate; /** * Optional. Action performed on behalf of the agent by transitioning to a target CX flow. */ flowTransition?: Schema$GoogleCloudDialogflowCxV3beta1FlowTransition; + /** + * Optional. Output only. Intent Match in flows. + */ + intentMatch?: Schema$GoogleCloudDialogflowCxV3beta1ActionIntentMatch; + /** + * Optional. Output only. LLM call performed by the agent. + */ + llmCall?: Schema$GoogleCloudDialogflowCxV3beta1LlmCall; /** * Optional. Action performed on behalf of the agent by invoking a child playbook. */ @@ -280,15 +300,124 @@ export namespace dialogflow_v3beta1 { * Optional. Action performed on behalf of the agent by transitioning to a target playbook. */ playbookTransition?: Schema$GoogleCloudDialogflowCxV3beta1PlaybookTransition; + /** + * Output only. Timestamp of the start of the agent action. + */ + startTime?: string | null; + /** + * Optional. Output only. The status of the action. + */ + status?: Schema$GoogleCloudDialogflowCxV3beta1Status; + /** + * Optional. Speech-to-text action performed by the agent. + */ + stt?: Schema$GoogleCloudDialogflowCxV3beta1ActionSTT; + /** + * Optional. The detailed tracing information for sub execution steps of the action. + */ + subExecutionSteps?: Schema$GoogleCloudDialogflowCxV3beta1Span[]; /** * Optional. Action performed on behalf of the agent by calling a plugin tool. */ toolUse?: Schema$GoogleCloudDialogflowCxV3beta1ToolUse; + /** + * Optional. Text-to-speech action performed by the agent. + */ + tts?: Schema$GoogleCloudDialogflowCxV3beta1ActionTTS; /** * Optional. Agent obtained a message from the customer. */ userUtterance?: Schema$GoogleCloudDialogflowCxV3beta1UserUtterance; } + /** + * Stores metadata of the state update action, such as a state machine execution in flows. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate { + /** + * The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`. + */ + destination?: string | null; + /** + * The type of the event that triggered the state update. + */ + eventType?: string | null; + /** + * The function call to execute. + */ + functionCall?: Schema$GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdateFunctionCall; + /** + * The updated page and flow state. + */ + pageState?: Schema$GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdatePageState; + /** + * The updated parameters. + */ + updatedParameters?: {[key: string]: any} | null; + } + /** + * Stores the metadata of a function call to execute. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdateFunctionCall { + /** + * The name of the function call. + */ + name?: string | null; + } + /** + * Stores the state of a page and its flow. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdatePageState { + /** + * The display name of the page. + */ + displayName?: string | null; + /** + * The ID of the page. Format: `projects//locations//agents//flows//pages/`. + */ + page?: string | null; + /** + * The status of the page. + */ + status?: string | null; + } + /** + * Stores metadata of the intent match action. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ActionIntentMatch { + /** + * The matched intent. + */ + matchedIntents?: Schema$GoogleCloudDialogflowCxV3beta1ActionIntentMatchMatchedIntent[]; + } + /** + * Stores the matched intent, which is the result of the intent match action. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ActionIntentMatchMatchedIntent { + /** + * The display name of the matched intent. + */ + displayName?: string | null; + /** + * The generative fallback response of the matched intent. + */ + generativeFallback?: {[key: string]: any} | null; + /** + * The ID of the matched intent. + */ + intentId?: string | null; + /** + * The score of the matched intent. + */ + score?: number | null; + } + /** + * Stores metadata of the Speech-to-Text action. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ActionSTT {} + /** + * Stores metadata of the Text-to-Speech action. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ActionTTS {} /** * Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-\>Flow-\>Page-\>Fulfillment/Parameter. */ @@ -589,6 +718,10 @@ export namespace dialogflow_v3beta1 { * AgentUtterance represents one message sent by the agent. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AgentUtterance { + /** + * Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer. + */ + requireGeneration?: boolean | null; /** * Required. Message content in text. */ @@ -1638,6 +1771,10 @@ export namespace dialogflow_v3beta1 { * Required. Name of the event. */ event?: string | null; + /** + * Optional. Unstructured text payload of the event. + */ + text?: string | null; } /** * An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. @@ -1726,6 +1863,15 @@ export namespace dialogflow_v3beta1 { */ updateTime?: string | null; } + /** + * Exception thrown during the execution of an action. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExceptionDetail { + /** + * Optional. The error message. + */ + errorMessage?: string | null; + } /** * Represents an experiment in an environment. */ @@ -2041,6 +2187,19 @@ export namespace dialogflow_v3beta1 { */ intentsUri?: string | null; } + /** + * The request message for Playbooks.ExportPlaybook. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest { + /** + * Optional. The data format of the exported agent. If not specified, `BLOB` is assumed. + */ + dataFormat?: string | null; + /** + * Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the playbook to. The format of this URI must be `gs:///`. If left unspecified, the serialized playbook is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + playbookUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -2168,7 +2327,7 @@ export namespace dialogflow_v3beta1 { globalImportStrategy?: string | null; } /** - * Stores metadata of the invocation of a CX flow. + * Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. */ export interface Schema$GoogleCloudDialogflowCxV3beta1FlowInvocation { /** @@ -2176,7 +2335,7 @@ export namespace dialogflow_v3beta1 { */ displayName?: string | null; /** - * Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`. + * Required. The unique identifier of the flow. Format: `projects//locations//agents/`. */ flow?: string | null; /** @@ -2217,6 +2376,10 @@ export namespace dialogflow_v3beta1 { * Required. The unique identifier of the flow. Format: `projects//locations//agents/`. */ flow?: string | null; + /** + * A list of input parameters for the action. + */ + inputActionParameters?: {[key: string]: any} | null; } /** * The response message for Flows.GetFlowValidationResult. @@ -2765,6 +2928,23 @@ export namespace dialogflow_v3beta1 { */ intentDisplayNames?: string[] | null; } + /** + * The request message for Playbooks.ImportPlaybook. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest { + /** + * Optional. Specifies the import strategy used when resolving resource conflicts. + */ + importStrategy?: Schema$GoogleCloudDialogflowCxV3beta1PlaybookImportStrategy; + /** + * Uncompressed raw byte content for playbook. + */ + playbookContent?: string | null; + /** + * [Dialogflow access control] (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + playbookUri?: string | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -3345,6 +3525,69 @@ export namespace dialogflow_v3beta1 { */ webhooks?: Schema$GoogleCloudDialogflowCxV3beta1Webhook[]; } + /** + * Stores metadata of the call of an LLM. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1LlmCall { + /** + * The model of the LLM call. + */ + model?: string | null; + /** + * A list of relevant examples used for the LLM prompt. + */ + retrievedExamples?: Schema$GoogleCloudDialogflowCxV3beta1LlmCallRetrievedExample[]; + /** + * The temperature of the LLM call. + */ + temperature?: number | null; + /** + * The token counts of the LLM call. + */ + tokenCount?: Schema$GoogleCloudDialogflowCxV3beta1LlmCallTokenCount; + } + /** + * Relevant example used for the LLM prompt. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1LlmCallRetrievedExample { + /** + * The display name of the example. + */ + exampleDisplayName?: string | null; + /** + * The id of the example. + */ + exampleId?: string | null; + /** + * Optional. The matched retrieval label of this LLM call. + */ + matchedRetrievalLabel?: string | null; + /** + * Retrieval strategy of the example. + */ + retrievalStrategy?: string | null; + } + /** + * Stores token counts of the LLM call. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1LlmCallTokenCount { + /** + * The number of tokens used for the conversation history in the prompt. + */ + conversationContextTokenCount?: string | null; + /** + * The number of tokens used for the retrieved examples in the prompt. + */ + exampleTokenCount?: string | null; + /** + * The total number of tokens used for the input to the LLM call. + */ + totalInputTokenCount?: string | null; + /** + * The total number of tokens used for the output of the LLM call. + */ + totalOutputTokenCount?: string | null; + } /** * Settings for LLM models. */ @@ -3455,6 +3698,23 @@ export namespace dialogflow_v3beta1 { */ triggerIntent?: string | null; } + /** + * A named metric is a metric with name, value and unit. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1NamedMetric { + /** + * The name of the metric. + */ + name?: string | null; + /** + * The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. + */ + unit?: string | null; + /** + * The value of the metric. + */ + value?: any | null; + } /** * Settings related to NLU. */ @@ -3684,6 +3944,23 @@ export namespace dialogflow_v3beta1 { */ updateTime?: string | null; } + /** + * The playbook import strategy used for resource conflict resolution associated with an ImportPlaybookRequest. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1PlaybookImportStrategy { + /** + * Optional. Specifies the import strategy used when resolving conflicts with the main playbook. If not specified, 'CREATE_NEW' is assumed. + */ + mainPlaybookImportStrategy?: string | null; + /** + * Optional. Specifies the import strategy used when resolving referenced playbook/flow conflicts. If not specified, 'CREATE_NEW' is assumed. + */ + nestedResourceImportStrategy?: string | null; + /** + * Optional. Specifies the import strategy used when resolving tool conflicts. If not specified, 'CREATE_NEW' is assumed. This will be applied after the main playbook and nested resource import strategies, meaning if the playbook that references the tool is skipped, the tool will also be skipped. + */ + toolImportStrategy?: string | null; + } /** * Input of the playbook. */ @@ -3711,7 +3988,7 @@ export namespace dialogflow_v3beta1 { steps?: Schema$GoogleCloudDialogflowCxV3beta1PlaybookStep[]; } /** - * Stores metadata of the invocation of a child playbook. + * Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. */ export interface Schema$GoogleCloudDialogflowCxV3beta1PlaybookInvocation { /** @@ -3747,6 +4024,10 @@ export namespace dialogflow_v3beta1 { * Optional. Summary string of the execution result of the child playbook. */ executionSummary?: string | null; + /** + * End state of the playbook. + */ + state?: string | null; } /** * Message of single step execution. @@ -3769,6 +4050,10 @@ export namespace dialogflow_v3beta1 { * Output only. The display name of the playbook. */ displayName?: string | null; + /** + * A list of input parameters for the action. + */ + inputActionParameters?: {[key: string]: any} | null; /** * Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. */ @@ -4210,6 +4495,19 @@ export namespace dialogflow_v3beta1 { */ trackingBranch?: string | null; } + /** + * The request message for Playbooks.RestorePlaybookVersion. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest {} + /** + * The response message for Playbooks.RestorePlaybookVersion. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse { + /** + * The updated playbook. + */ + playbook?: Schema$GoogleCloudDialogflowCxV3beta1Playbook; + } /** * The request message for Tools.RestoreToolVersion. */ @@ -4483,6 +4781,31 @@ export namespace dialogflow_v3beta1 { */ session?: string | null; } + /** + * A span represents a sub execution step of an action. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1Span { + /** + * Timestamp of the completion of the span. + */ + completeTime?: string | null; + /** + * The unordered collection of metrics in this span. + */ + metrics?: Schema$GoogleCloudDialogflowCxV3beta1NamedMetric[]; + /** + * The name of the span. + */ + name?: string | null; + /** + * Timestamp of the start of the span. + */ + startTime?: string | null; + /** + * The metadata tags of the span such as span type. + */ + tags?: string[] | null; + } /** * Settings related to speech recognition. */ @@ -4496,6 +4819,15 @@ export namespace dialogflow_v3beta1 { * The request message for Experiments.StartExperiment. */ export interface Schema$GoogleCloudDialogflowCxV3beta1StartExperimentRequest {} + /** + * The status of the action. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1Status { + /** + * Optional. The exception thrown during the execution of the action. + */ + exception?: Schema$GoogleCloudDialogflowCxV3beta1ExceptionDetail; + } /** * The request message for Experiments.StopExperiment. */ @@ -4764,11 +5096,19 @@ export namespace dialogflow_v3beta1 { * Required. Key location in the request. */ requestLocation?: string | null; + /** + * Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForApiKey?: string | null; } /** * Config for authentication using bearer token. */ export interface Schema$GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig { + /** + * Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForToken?: string | null; /** * Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. */ @@ -4794,6 +5134,10 @@ export namespace dialogflow_v3beta1 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint in the OAuth provider to exchange for an access token. */ @@ -5044,6 +5388,10 @@ export namespace dialogflow_v3beta1 { * Optional. Name of the action to be called during the tool use. */ action?: string | null; + /** + * Optional. Data store tool trace. + */ + dataStoreToolTrace?: Schema$GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace; /** * Output only. The display name of the tool. */ @@ -5060,6 +5408,32 @@ export namespace dialogflow_v3beta1 { * Required. The tool that should be used. Format: `projects//locations//agents//tools/`. */ tool?: string | null; + /** + * Optional. Webhook tool trace. + */ + webhookToolTrace?: Schema$GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace; + } + /** + * The tracing information for the data store tool. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace { + /** + * Optional. Data store connection feature output signals. + */ + dataStoreConnectionSignals?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals; + } + /** + * The tracing information for the webhook tool. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace { + /** + * Optional. The tag of the webhook. + */ + webhookTag?: string | null; + /** + * Optional. The url of the webhook. + */ + webhookUri?: string | null; } /** * Tool version is a snapshot of the tool at certain timestamp. @@ -5313,6 +5687,14 @@ export namespace dialogflow_v3beta1 { * UserUtterance represents one message sent by the customer. */ export interface Schema$GoogleCloudDialogflowCxV3beta1UserUtterance { + /** + * Optional. Audio input. + */ + audio?: string | null; + /** + * Optional. Tokens of the audio input. + */ + audioTokens?: number[] | null; /** * Required. Message content in text. */ @@ -5503,6 +5885,18 @@ export namespace dialogflow_v3beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -5536,11 +5930,24 @@ export namespace dialogflow_v3beta1 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -6619,6 +7026,10 @@ export namespace dialogflow_v3beta1 { * The natural language text to be processed. */ text?: Schema$GoogleCloudDialogflowCxV3TextInput; + /** + * The results of a tool executed by the client. + */ + toolCallResult?: Schema$GoogleCloudDialogflowCxV3ToolCallResult; } /** * Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. @@ -6672,6 +7083,10 @@ export namespace dialogflow_v3beta1 { * Returns a text response. */ text?: Schema$GoogleCloudDialogflowCxV3ResponseMessageText; + /** + * Returns the definition of a tool call that should be executed by the client. + */ + toolCall?: Schema$GoogleCloudDialogflowCxV3ToolCall; } /** * Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. @@ -6953,17 +7368,64 @@ export namespace dialogflow_v3beta1 { text?: string | null; } /** - * A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + * Represents a call of a specific tool's action with the specified inputs. */ - export interface Schema$GoogleCloudDialogflowCxV3TransitionRoute { + export interface Schema$GoogleCloudDialogflowCxV3ToolCall { /** - * The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + * Required. The name of the tool's action associated with this call. */ - condition?: string | null; + action?: string | null; /** - * Optional. The description of the transition route. The maximum length is 500 characters. + * Optional. The action's input parameters. */ - description?: string | null; + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action that has been executed by the client. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowCxV3ToolCallResultError; + /** + * The tool call's output parameters. + */ + outputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } + /** + * A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + */ + export interface Schema$GoogleCloudDialogflowCxV3TransitionRoute { + /** + * The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + */ + condition?: string | null; + /** + * Optional. The description of the transition route. The maximum length is 500 characters. + */ + description?: string | null; /** * The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. */ @@ -7091,6 +7553,18 @@ export namespace dialogflow_v3beta1 { * The HTTP request headers to send together with webhook requests. */ requestHeaders?: {[key: string]: string} | null; + /** + * Optional. The SecretManager secret version resource storing the username:password pair for HTTP Basic authentication. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForUsernamePassword?: string | null; + /** + * Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used. + */ + secretVersionsForRequestHeaders?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; + } | null; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -7124,11 +7598,24 @@ export namespace dialogflow_v3beta1 { * Optional. The OAuth scopes to grant. */ scopes?: string[] | null; + /** + * Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersionForClientSecret?: string | null; /** * Required. The token endpoint provided by the 3rd party platform to exchange an access token. */ tokenEndpoint?: string | null; } + /** + * Represents the value of an HTTP header stored in a SecretManager secret version. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue { + /** + * Required. The SecretManager secret version resource storing the header value. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + secretVersion?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -7705,6 +8192,23 @@ export namespace dialogflow_v3beta1 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2beta1ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2beta1ToolCallResult; } /** * Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation. @@ -9292,6 +9796,65 @@ export namespace dialogflow_v3beta1 { */ dtmfEvents?: string[] | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Output only. Create time of the tool call. + */ + createTime?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Only populated if the response content is utf-8 encoded. + */ + content?: string | null; + /** + * Output only. Create time of the tool call result. + */ + createTime?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowV2beta1ToolCallResultError; + /** + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). + */ + rawContent?: string | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * The request message for a webhook call. */ @@ -9726,6 +10289,23 @@ export namespace dialogflow_v3beta1 { * Optional. Suggested summary. */ summarySuggestion?: Schema$GoogleCloudDialogflowV2SummarySuggestion; + /** + * Optional. List of request and response for tool calls executed. + */ + toolCallInfo?: Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo[]; + } + /** + * Request and response for a tool call. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo { + /** + * Required. Request for a tool call. + */ + toolCall?: Schema$GoogleCloudDialogflowV2ToolCall; + /** + * Required. Response for a tool call. + */ + toolCallResult?: Schema$GoogleCloudDialogflowV2ToolCallResult; } /** * Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation. @@ -10957,6 +11537,65 @@ export namespace dialogflow_v3beta1 { */ summary?: string | null; } + /** + * Represents a call of a specific tool's action with the specified inputs. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCall { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Output only. Create time of the tool call. + */ + createTime?: string | null; + /** + * Optional. The action's input parameters. + */ + inputParameters?: {[key: string]: any} | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * The result of calling a tool's action. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResult { + /** + * Required. The name of the tool's action associated with this call. + */ + action?: string | null; + /** + * Only populated if the response content is utf-8 encoded. + */ + content?: string | null; + /** + * Output only. Create time of the tool call result. + */ + createTime?: string | null; + /** + * The tool call's error. + */ + error?: Schema$GoogleCloudDialogflowV2ToolCallResultError; + /** + * Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). + */ + rawContent?: string | null; + /** + * Required. The tool associated with this call. Format: `projects//locations//tools/`. + */ + tool?: string | null; + } + /** + * An error produced by the tool call. + */ + export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { + /** + * Optional. The error message of the function. + */ + message?: string | null; + } /** * Metadata for a ConversationModels.UndeployConversationModel operation. */ @@ -11419,6 +12058,10 @@ export namespace dialogflow_v3beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -21480,6 +22123,102 @@ export namespace dialogflow_v3beta1 { } } + /** + * Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Playbooks$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Export; + 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}:export').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 specified Playbook. * @@ -21574,6 +22313,102 @@ export namespace dialogflow_v3beta1 { } } + /** + * Imports the specified playbook to the specified agent from a binary file. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Playbooks$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Playbooks$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Playbooks$Import; + 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}/playbooks:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns a list of playbooks in the specified agent. * @@ -21786,6 +22621,18 @@ export namespace dialogflow_v3beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Export + extends StandardParameters { + /** + * Required. The name of the playbook to export. Format: `projects//locations//agents//playbooks/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest; + } export interface Params$Resource$Projects$Locations$Agents$Playbooks$Get extends StandardParameters { /** @@ -21793,6 +22640,18 @@ export namespace dialogflow_v3beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Import + extends StandardParameters { + /** + * Required. The agent to import the playbook into. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest; + } export interface Params$Resource$Projects$Locations$Agents$Playbooks$List extends StandardParameters { /** @@ -22754,6 +23613,104 @@ export namespace dialogflow_v3beta1 { ); } } + + /** + * Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook 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$Playbooks$Versions$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore, + callback: BodyResponseCallback + ): void; + restore( + callback: BodyResponseCallback + ): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Playbooks$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$Playbooks$Versions$Create @@ -22797,6 +23754,18 @@ export namespace dialogflow_v3beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Agents$Playbooks$Versions$Restore + extends StandardParameters { + /** + * Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest; + } export class Resource$Projects$Locations$Agents$Sessions { context: APIRequestContext; diff --git a/src/apis/digitalassetlinks/v1.ts b/src/apis/digitalassetlinks/v1.ts index 76451226266..008c2f82356 100644 --- a/src/apis/digitalassetlinks/v1.ts +++ b/src/apis/digitalassetlinks/v1.ts @@ -168,6 +168,10 @@ export namespace digitalassetlinks_v1 { * If specified, will be used in any given template statement that doesn’t specify a target. */ defaultTarget?: Schema$Asset; + /** + * Same configuration as in CheckRequest; all statement checks will use the same configuration. + */ + returnRelationExtensions?: boolean | null; /** * 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. */ @@ -215,6 +219,10 @@ export namespace digitalassetlinks_v1 { * From serving time, how much longer the response should be considered valid barring further updates. REQUIRED */ maxAge?: string | null; + /** + * Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset. When requested, the API will return relation_extensions specified in any and all statements linking the requested source and target assets by the relation specified in the request. + */ + relationExtensions?: Array<{[key: string]: any}> | null; } /** * Response message for the List call. @@ -245,6 +253,10 @@ export namespace digitalassetlinks_v1 { * The relation identifies the use of the statement as intended by the source asset's owner (that is, the person or entity who issued the statement). Every complete statement has a 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. Example: `delegate_permission/common.handle_all_urls` REQUIRED */ relation?: string | null; + /** + * Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset. These relation extensions should be specified in the `relation_extensions` object, keyed by the relation type they're associated with. { relation: ["delegate_permission/common.handle_all_urls"], target: {...\}, relation_extensions: { "delegate_permission/common.handle_all_urls": { ...handle_all_urls specific payload specified here... \} \} \} When requested, and specified in the statement file, the API will return relation_extensions associated with the statement's relation type. i.e. the API will only return relation_extensions specified for "delegate_permission/common.handle_all_urls" if this statement object's relation type is "delegate_permission/common.handle_all_urls". + */ + relationExtensions?: {[key: string]: any} | null; /** * Every statement has a source asset. REQUIRED */ @@ -480,6 +492,10 @@ export namespace digitalassetlinks_v1 { * 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`. */ relation?: string; + /** + * Whether to return relation_extensions payloads specified in the source Digital Asset Links statements linking the requested source and target assets by the requested relation type. If this is set to `false` (default), relation_extensions specified will not be returned, even if they are specified in the DAL statement file. If set to `true`, the API will propagate any and all relation_extensions, across statements, linking the source and target assets by the requested relation type, if specified in the DAL statement file. + */ + returnRelationExtensions?: boolean; /** * The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). */ @@ -606,6 +622,10 @@ export namespace digitalassetlinks_v1 { * Use only associations that match the specified relation. See the [`Statement`](#Statement) message for a detailed definition of relation strings. For a query to match a statement, one of the following must be true: * both the query's and the statement's relation strings match exactly, or * the query's relation string is empty or missing. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`. */ relation?: string; + /** + * Whether to return any relation_extensions payloads specified in the source digital asset links statements. If this is set to `false` (default), relation_extensions specified will not be returned, even if they are specified in the DAL statement file. If set to `true`, the API will propagate relation_extensions associated with each statement's relation type, if specified in the DAL statement file. + */ + returnRelationExtensions?: boolean; /** * The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). */ diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index 1f2ed6e69ba..ca78869c1b6 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -505,6 +505,10 @@ export namespace discoveryengine_v1 { * Output only. The connector contains the necessary parameters and is configured to support actions. */ isActionConfigured?: boolean | null; + /** + * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. + */ + serviceName?: string | null; } /** * Configuration data for advance site search. @@ -1049,7 +1053,7 @@ export namespace discoveryengine_v1 { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1alphaConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -1437,6 +1441,10 @@ export namespace discoveryengine_v1 { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnector { + /** + * Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. + */ + aclEnabled?: boolean | null; /** * Optional. Action configurations to make the connector support actions. */ @@ -1457,6 +1465,10 @@ export namespace discoveryengine_v1 { * Output only. User actions that must be completed before the connector can start syncing data. */ blockingReasons?: string[] | null; + /** + * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. + */ + connectorModes?: 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. */ @@ -1473,6 +1485,10 @@ export namespace discoveryengine_v1 { * Optional. Any target destinations used to connect to third-party services. */ destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfig[]; + /** + * Optional. Any params and credentials used specifically for EUA connectors. + */ + endUserConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig; /** * List of entities from the connected data source to ingest. */ @@ -1521,6 +1537,10 @@ export namespace discoveryengine_v1 { * Output only. real-time sync state */ realtimeState?: string | null; + /** + * Optional. The configuration for realtime sync. + */ + realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig; /** * 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. */ @@ -1546,6 +1566,32 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Any params and credentials used specifically for EUA connectors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig { + /** + * Optional. Any additional parameters needed for EUA. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors. + */ + authParams?: {[key: string]: any} | null; + } + /** + * The configuration for realtime sync to store additional params for realtime sync. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig { + /** + * Optional. The ID of the Secret Manager secret used for webhook secret. + */ + realtimeSyncSecret?: string | null; + /** + * Optional. Webhook url for the connector to specify additional params for realtime sync. + */ + webhookUri?: string | null; + } /** * Represents an entity in the data source. For example, the `Account` object in Salesforce. */ @@ -1958,7 +2004,28 @@ export namespace discoveryengine_v1 { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -2114,6 +2181,10 @@ export namespace discoveryengine_v1 { * Additional config specs for a Media Recommendation engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig; /** * 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` */ @@ -2131,6 +2202,28 @@ export namespace discoveryengine_v1 { */ type?: string | null; } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } /** * Custom threshold for `cvr` optimization_objective. */ @@ -2144,6 +2237,15 @@ export namespace discoveryengine_v1 { */ targetFieldValueFloat?: number | null; } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Additional information of a recommendation engine. */ @@ -3135,6 +3237,10 @@ export namespace discoveryengine_v1 { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -3177,7 +3283,7 @@ export namespace discoveryengine_v1 { */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * 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. + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** @@ -3245,7 +3351,7 @@ export namespace discoveryengine_v1 { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * 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 + * 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_backend 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_backend 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; /** @@ -3306,7 +3412,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec { /** - * 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. + * 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$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[]; } @@ -4026,6 +4132,10 @@ export namespace discoveryengine_v1 { * Information of an end user. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfo { + /** + * Optional. IANA time zone, e.g. Europe/Budapest. + */ + timeZone?: string | null; /** * 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. */ @@ -4143,6 +4253,52 @@ export namespace discoveryengine_v1 { */ referenceId?: string | null; } + /** + * The specification for answer generation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpec { + /** + * Optional. The specification for user specified classifier spec. + */ + userDefinedClassifierSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec; + } + /** + * The specification for user defined classifier. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec { + /** + * Optional. Whether or not to enable and include user defined classifier. + */ + enableUserDefinedClassifier?: boolean | null; + /** + * Optional. The model id to be used for the user defined classifier. + */ + modelId?: string | null; + /** + * Optional. The preamble to be used for the user defined classifier. + */ + preamble?: string | null; + /** + * Optional. The seed value to be used for the user defined classifier. + */ + seed?: number | null; + /** + * Optional. The task marker to be used for the user defined classifier. + */ + taskMarker?: string | null; + /** + * Optional. The temperature value to be used for the user defined classifier. + */ + temperature?: number | null; + /** + * Optional. The top-k value to be used for the user defined classifier. + */ + topK?: string | null; + /** + * Optional. The top-p value to be used for the user defined classifier. + */ + topP?: number | null; + } /** * Grounding support for a claim in `answer_text`. */ @@ -5010,7 +5166,7 @@ export namespace discoveryengine_v1 { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -5278,6 +5434,10 @@ export namespace discoveryengine_v1 { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * 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. + */ + aclEnabled?: boolean | null; /** * Optional. Configuration for advanced site search. */ @@ -5584,7 +5744,28 @@ export namespace discoveryengine_v1 { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -5651,6 +5832,10 @@ export namespace discoveryengine_v1 { * 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. */ industryVertical?: string | null; + /** + * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. + */ + mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig; /** * 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. */ @@ -5724,6 +5909,75 @@ export namespace discoveryengine_v1 { */ companyName?: string | null; } + /** + * Additional config specs for a Media Recommendation engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig; + /** + * 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` + */ + optimizationObjective?: string | null; + /** + * 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). + */ + optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig; + /** + * 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. + */ + trainingState?: string | null; + /** + * 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 | null; + } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } + /** + * Custom threshold for `cvr` optimization_objective. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig { + /** + * Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. + */ + targetField?: string | null; + /** + * Required. The threshold to be applied to the target (e.g., 0.5). + */ + targetFieldValueFloat?: number | null; + } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Configurations for a Search Engine. */ @@ -6324,6 +6578,10 @@ export namespace discoveryengine_v1 { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -6362,7 +6620,7 @@ export namespace discoveryengine_v1 { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * 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. + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** @@ -6430,7 +6688,7 @@ export namespace discoveryengine_v1 { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * 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 + * 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_backend 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_backend 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; /** @@ -6491,7 +6749,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * 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. + * 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$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } @@ -7097,6 +7355,10 @@ export namespace discoveryengine_v1 { * Information of an end user. */ export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + /** + * Optional. IANA time zone, e.g. Europe/Budapest. + */ + timeZone?: string | null; /** * 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. */ @@ -7307,6 +7569,10 @@ export namespace discoveryengine_v1 { * Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned. */ groundingCheckRequired?: boolean | null; + /** + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. + */ + score?: number | null; /** * 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). */ @@ -7320,11 +7586,19 @@ export namespace discoveryengine_v1 { * 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. */ citationThreshold?: number | null; + /** + * The control flag that enables claim-level grounding score in the response. + */ + enableClaimLevelScore?: boolean | null; } /** * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. */ export interface Schema$GoogleCloudDiscoveryengineV1Chunk { + /** + * Output only. Annotation contents if the current chunk contains annotations. + */ + annotationContents?: string[] | null; /** * Output only. Metadata of the current chunk. */ @@ -7333,6 +7607,10 @@ export namespace discoveryengine_v1 { * Content is a string from a document (parsed content). */ content?: string | null; + /** + * Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUrls?: string[] | null; /** * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ @@ -7548,7 +7826,7 @@ export namespace discoveryengine_v1 { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -7979,6 +8257,10 @@ export namespace discoveryengine_v1 { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * 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. + */ + aclEnabled?: boolean | null; /** * Optional. Configuration for advanced site search. */ @@ -8207,7 +8489,11 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1Document { /** - * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. + * Access control information for the document. + */ + aclInfo?: Schema$GoogleCloudDiscoveryengineV1DocumentAclInfo; + /** + * The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. */ content?: Schema$GoogleCloudDiscoveryengineV1DocumentContent; /** @@ -8247,12 +8533,34 @@ export namespace discoveryengine_v1 { */ structData?: {[key: string]: any} | null; } + /** + * ACL Information of the Document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentAclInfo { + /** + * Readers of the document. + */ + readers?: Schema$GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction[]; + } + /** + * AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --\> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ] \} ] \} \} Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" \}, { "group_id": "group_3" \}, { "user_id": "user_2" \} ], \}, { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ], \} ] \} \} + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction { + /** + * All users within the Identity Provider. + */ + idpWide?: boolean | null; + /** + * List of principals. + */ + principals?: Schema$GoogleCloudDiscoveryengineV1Principal[]; + } /** * Unstructured data linked to this document. */ export interface Schema$GoogleCloudDiscoveryengineV1DocumentContent { /** - * 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. + * The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. */ mimeType?: string | null; /** @@ -8385,7 +8693,28 @@ export namespace discoveryengine_v1 { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -8465,6 +8794,10 @@ export namespace discoveryengine_v1 { * 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. */ industryVertical?: string | null; + /** + * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. + */ + mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig; /** * 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. */ @@ -8538,6 +8871,75 @@ export namespace discoveryengine_v1 { */ companyName?: string | null; } + /** + * Additional config specs for a Media Recommendation engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig; + /** + * 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` + */ + optimizationObjective?: string | null; + /** + * 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). + */ + optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig; + /** + * 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. + */ + trainingState?: string | null; + /** + * 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 | null; + } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } + /** + * Custom threshold for `cvr` optimization_objective. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig { + /** + * Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. + */ + targetField?: string | null; + /** + * Required. The threshold to be applied to the target (e.g., 0.5). + */ + targetFieldValueFloat?: number | null; + } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Configurations for a Search Engine. */ @@ -8559,6 +8961,10 @@ export namespace discoveryengine_v1 { * Text content of the fact chunk. Can be at most 10K characters long. */ chunkText?: string | null; + /** + * The domain of the source. + */ + domain?: string | null; /** * The index of this chunk. Currently, only used for the streaming mode. */ @@ -8571,8 +8977,16 @@ export namespace discoveryengine_v1 { * More fine-grained information for the source reference. */ sourceMetadata?: {[key: string]: string} | null; - } - /** + /** + * The title of the source. + */ + title?: string | null; + /** + * The URI of the source. + */ + uri?: string | null; + } + /** * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method. */ export interface Schema$GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse { @@ -9096,6 +9510,15 @@ export namespace discoveryengine_v1 { */ minimum?: number | null; } + /** + * Response message for CmekConfigService.ListCmekConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ListCmekConfigsResponse { + /** + * All the customer's CmekConfigs. + */ + cmekConfigs?: Schema$GoogleCloudDiscoveryengineV1CmekConfig[]; + } /** * Response for ListControls method. */ @@ -9298,6 +9721,19 @@ export namespace discoveryengine_v1 { */ totalPanels?: number | null; } + /** + * Principal identifier of a user or a group. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Principal { + /** + * 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. + */ + 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 account, user_id is the mapped user identifier configured during the workforcepool config. + */ + userId?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -9775,6 +10211,10 @@ export namespace discoveryengine_v1 { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -9813,7 +10253,7 @@ export namespace discoveryengine_v1 { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec; /** - * 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. + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]; /** @@ -9914,7 +10354,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpec { /** - * 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. + * 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$GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec[]; } @@ -10510,6 +10950,10 @@ export namespace discoveryengine_v1 { * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. */ export interface Schema$GoogleCloudDiscoveryengineV1ServingConfig { + /** + * Optional. The specification for answer generation. + */ + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpec; /** * 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. */ @@ -11084,6 +11528,10 @@ export namespace discoveryengine_v1 { * Information of an end user. */ export interface Schema$GoogleCloudDiscoveryengineV1UserInfo { + /** + * Optional. IANA time zone, e.g. Europe/Budapest. + */ + timeZone?: string | null; /** * 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. */ @@ -11337,54 +11785,708 @@ export namespace discoveryengine_v1 { version?: string | null; } - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + + /** + * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions + ): GaxiosPromise; + provision( + params?: Params$Resource$Projects$Provision, + options?: MethodOptions + ): GaxiosPromise; + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + callback: BodyResponseCallback + ): void; + provision( + callback: BodyResponseCallback + ): void; + provision( + paramsOrCallback?: + | Params$Resource$Projects$Provision + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Provision; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Provision; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:provision').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Provision + extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1ProvisionProjectRequest; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + cmekConfigs: Resource$Projects$Locations$Cmekconfigs; + collections: Resource$Projects$Locations$Collections; + dataStores: Resource$Projects$Locations$Datastores; + groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + identityMappingStores: Resource$Projects$Locations$Identitymappingstores; + operations: Resource$Projects$Locations$Operations; + podcasts: Resource$Projects$Locations$Podcasts; + rankingConfigs: Resource$Projects$Locations$Rankingconfigs; + userEvents: Resource$Projects$Locations$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.cmekConfigs = new Resource$Projects$Locations$Cmekconfigs( + this.context + ); + this.collections = new Resource$Projects$Locations$Collections( + this.context + ); + this.dataStores = new Resource$Projects$Locations$Datastores( + this.context + ); + this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( + this.context + ); + this.identityMappingStores = + new Resource$Projects$Locations$Identitymappingstores(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.podcasts = new Resource$Projects$Locations$Podcasts(this.context); + this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Userevents( + this.context + ); + } + + /** + * Gets the 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. + */ + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getCmekConfig( + params?: Params$Resource$Projects$Locations$Getcmekconfig, + options?: MethodOptions + ): GaxiosPromise; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + callback: BodyResponseCallback + ): void; + getCmekConfig( + callback: BodyResponseCallback + ): void; + getCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getcmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getcmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getcmekconfig; + 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 + ); + } + } + + /** + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected 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. + */ + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateCmekConfig( + params?: Params$Resource$Projects$Locations$Updatecmekconfig, + options?: MethodOptions + ): GaxiosPromise; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + callback: BodyResponseCallback + ): void; + updateCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updatecmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updatecmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updatecmekconfig; + 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$Getcmekconfig + extends StandardParameters { + /** + * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Updatecmekconfig + extends StandardParameters { + /** + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + */ + name?: string; + /** + * Set the following CmekConfig as the default to be used for child resources if one is not specified. + */ + setDefault?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; + } + + export class Resource$Projects$Locations$Cmekconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + 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 + '/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 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. + */ + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$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 CmekConfigs 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$Cmekconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Cmekconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$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}/cmekConfigs').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 + ); + } } /** - * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected 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. */ - provision( - params: Params$Resource$Projects$Provision, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - provision( - params?: Params$Resource$Projects$Provision, + patch( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options?: MethodOptions ): GaxiosPromise; - provision( - params: Params$Resource$Projects$Provision, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, callback: BodyResponseCallback ): void; - provision( + patch( callback: BodyResponseCallback ): void; - provision( + patch( paramsOrCallback?: - | Params$Resource$Projects$Provision + | Params$Resource$Projects$Locations$Cmekconfigs$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11400,12 +12502,12 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Provision; + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Provision; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Patch; options = {}; } @@ -11419,11 +12521,8 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:provision').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -11444,53 +12543,42 @@ export namespace discoveryengine_v1 { } } - export interface Params$Resource$Projects$Provision + export interface Params$Resource$Projects$Locations$Cmekconfigs$Delete extends StandardParameters { /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + * 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 { /** - * Request body metadata + * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1ProvisionProjectRequest; + name?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$List + extends StandardParameters { + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch + extends StandardParameters { + /** + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + */ + name?: string; + /** + * Set the following CmekConfig as the default to be used for child resources if one is not specified. + */ + setDefault?: boolean; - export class Resource$Projects$Locations { - context: APIRequestContext; - collections: Resource$Projects$Locations$Collections; - dataStores: Resource$Projects$Locations$Datastores; - groundingConfigs: Resource$Projects$Locations$Groundingconfigs; - identityMappingStores: Resource$Projects$Locations$Identitymappingstores; - operations: Resource$Projects$Locations$Operations; - podcasts: Resource$Projects$Locations$Podcasts; - rankingConfigs: Resource$Projects$Locations$Rankingconfigs; - userEvents: Resource$Projects$Locations$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.collections = new Resource$Projects$Locations$Collections( - this.context - ); - this.dataStores = new Resource$Projects$Locations$Datastores( - this.context - ); - this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( - this.context - ); - this.identityMappingStores = - new Resource$Projects$Locations$Identitymappingstores(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.podcasts = new Resource$Projects$Locations$Podcasts(this.context); - this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Userevents( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; } export class Resource$Projects$Locations$Collections { @@ -22593,6 +23681,96 @@ export namespace discoveryengine_v1 { 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$Collections$Engines$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$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. * @@ -22787,6 +23965,18 @@ export namespace discoveryengine_v1 { } } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get extends StandardParameters { /** diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index d3e9182f42b..7238ce1baa6 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -179,6 +179,10 @@ export namespace discoveryengine_v1alpha { * 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; + /** + * For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads. + */ + destinationBlobMintIndex?: number | 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. */ @@ -191,6 +195,10 @@ export namespace discoveryengine_v1alpha { * 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; + /** + * For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads. + */ + originalObjectBlobMintIndex?: number | null; /** * Request class to use for all Blobstore operations for this request. */ @@ -895,6 +903,10 @@ export namespace discoveryengine_v1alpha { * Output only. The connector contains the necessary parameters and is configured to support actions. */ isActionConfigured?: boolean | null; + /** + * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. + */ + serviceName?: string | null; } /** * Request message for CompletionService.AdvancedCompleteQuery method. . @@ -904,6 +916,10 @@ export namespace discoveryengine_v1alpha { * Optional. Specification to boost suggestions matching the condition. */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec; + /** + * Optional. Experiment ids for this request. + */ + experimentIds?: string[] | null; /** * 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. */ @@ -938,7 +954,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec { /** - * 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. + * Condition boost specifications. If a suggestion matches multiple conditions in the specifications, 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. */ conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[]; } @@ -1282,6 +1298,52 @@ export namespace discoveryengine_v1alpha { */ referenceId?: string | null; } + /** + * The specification for answer generation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec { + /** + * Optional. The specification for user specified classifier spec. + */ + userDefinedClassifierSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec; + } + /** + * The specification for user defined classifier. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec { + /** + * Optional. Whether or not to enable and include user defined classifier. + */ + enableUserDefinedClassifier?: boolean | null; + /** + * Optional. The model id to be used for the user defined classifier. + */ + modelId?: string | null; + /** + * Optional. The preamble to be used for the user defined classifier. + */ + preamble?: string | null; + /** + * Optional. The seed value to be used for the user defined classifier. + */ + seed?: number | null; + /** + * Optional. The task marker to be used for the user defined classifier. + */ + taskMarker?: string | null; + /** + * Optional. The temperature value to be used for the user defined classifier. + */ + temperature?: number | null; + /** + * Optional. The top-k value to be used for the user defined classifier. + */ + topK?: string | null; + /** + * Optional. The top-p value to be used for the user defined classifier. + */ + topP?: number | null; + } /** * Grounding support for a claim in `answer_text`. */ @@ -2286,6 +2348,10 @@ export namespace discoveryengine_v1alpha { * Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned. */ groundingCheckRequired?: boolean | null; + /** + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. + */ + score?: number | null; /** * 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). */ @@ -2299,6 +2365,10 @@ export namespace discoveryengine_v1alpha { * 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. */ citationThreshold?: number | null; + /** + * The control flag that enables claim-level grounding score in the response. + */ + enableClaimLevelScore?: boolean | null; } /** * Request for CheckRequirement method. @@ -2367,6 +2437,10 @@ export namespace discoveryengine_v1alpha { * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaChunk { + /** + * Output only. Annotation contents if the current chunk contains annotations. + */ + annotationContents?: string[] | null; /** * Output only. Metadata of the current chunk. */ @@ -2375,6 +2449,10 @@ export namespace discoveryengine_v1alpha { * Content is a string from a document (parsed content). */ content?: string | null; + /** + * Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUrls?: string[] | null; /** * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ @@ -2611,7 +2689,7 @@ export namespace discoveryengine_v1alpha { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1alphaConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -3179,6 +3257,10 @@ export namespace discoveryengine_v1alpha { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnector { + /** + * Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. + */ + aclEnabled?: boolean | null; /** * Optional. Action configurations to make the connector support actions. */ @@ -3199,6 +3281,10 @@ export namespace discoveryengine_v1alpha { * Output only. User actions that must be completed before the connector can start syncing data. */ blockingReasons?: string[] | null; + /** + * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. + */ + connectorModes?: 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. */ @@ -3215,6 +3301,10 @@ export namespace discoveryengine_v1alpha { * Optional. Any target destinations used to connect to third-party services. */ destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfig[]; + /** + * Optional. Any params and credentials used specifically for EUA connectors. + */ + endUserConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig; /** * List of entities from the connected data source to ingest. */ @@ -3263,6 +3353,10 @@ export namespace discoveryengine_v1alpha { * Output only. real-time sync state */ realtimeState?: string | null; + /** + * Optional. The configuration for realtime sync. + */ + realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig; /** * 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. */ @@ -3288,6 +3382,32 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Any params and credentials used specifically for EUA connectors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig { + /** + * Optional. Any additional parameters needed for EUA. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors. + */ + authParams?: {[key: string]: any} | null; + } + /** + * The configuration for realtime sync to store additional params for realtime sync. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig { + /** + * Optional. The ID of the Secret Manager secret used for webhook secret. + */ + realtimeSyncSecret?: string | null; + /** + * Optional. Webhook url for the connector to specify additional params for realtime sync. + */ + webhookUri?: string | null; + } /** * Represents an entity in the data source. For example, the `Account` object in Salesforce. */ @@ -3642,7 +3762,7 @@ export namespace discoveryengine_v1alpha { */ aclInfo?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo; /** - * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. + * The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. */ content?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentContent; /** @@ -3709,7 +3829,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentContent { /** - * 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. + * The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. */ mimeType?: string | null; /** @@ -3842,7 +3962,28 @@ export namespace discoveryengine_v1alpha { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -4020,6 +4161,10 @@ export namespace discoveryengine_v1alpha { * Additional config specs for a Media Recommendation engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig; /** * 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` */ @@ -4037,6 +4182,28 @@ export namespace discoveryengine_v1alpha { */ type?: string | null; } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } /** * Custom threshold for `cvr` optimization_objective. */ @@ -4050,6 +4217,15 @@ export namespace discoveryengine_v1alpha { */ targetFieldValueFloat?: number | null; } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Additional information of a recommendation engine. */ @@ -4229,6 +4405,10 @@ export namespace discoveryengine_v1alpha { * Text content of the fact chunk. Can be at most 10K characters long. */ chunkText?: string | null; + /** + * The domain of the source. + */ + domain?: string | null; /** * The index of this chunk. Currently, only used for the streaming mode. */ @@ -4241,6 +4421,14 @@ export namespace discoveryengine_v1alpha { * More fine-grained information for the source reference. */ sourceMetadata?: {[key: string]: string} | null; + /** + * The title of the source. + */ + title?: string | null; + /** + * The URI of the source. + */ + uri?: string | null; } /** * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method. @@ -4385,6 +4573,35 @@ export namespace discoveryengine_v1alpha { */ inputUris?: string[] | null; } + /** + * Response message for DataConnectorService.GetConnectorSecret. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse { + /** + * The app name of the associated Connector. + */ + app?: string | null; + /** + * The authorization uri for the data connector. + */ + authorizationUri?: string | null; + /** + * The client id of the associated Connector. + */ + clientId?: string | null; + /** + * The instance name of the associated Connector. + */ + instance?: string | null; + /** + * The redirect url of the associated Connector. + */ + redirectUri?: string | null; + /** + * The tenant id of the associated Connector. + */ + tenantId?: string | null; + } /** * Request for GetSession method. */ @@ -6363,6 +6580,10 @@ export namespace discoveryengine_v1alpha { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -6405,7 +6626,7 @@ export namespace discoveryengine_v1alpha { */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * 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. + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** @@ -6473,7 +6694,7 @@ export namespace discoveryengine_v1alpha { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * 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 + * 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_backend 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_backend 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; /** @@ -6534,7 +6755,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec { /** - * 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. + * 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$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[]; } @@ -7443,6 +7664,10 @@ export namespace discoveryengine_v1alpha { * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig { + /** + * Optional. The specification for answer generation. + */ + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec; /** * 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. */ @@ -8203,6 +8428,10 @@ export namespace discoveryengine_v1alpha { * Information of an end user. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfo { + /** + * Optional. IANA time zone, e.g. Europe/Budapest. + */ + timeZone?: string | null; /** * 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. */ @@ -8391,9 +8620,13 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings { /** - * Whether or not the Google search grounding toggle is shown. + * Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead. */ googleSearchGroundingEnabled?: boolean | null; + /** + * Optional. The type of web grounding to use. + */ + webGroundingType?: string | null; } /** * Read-only collection component that contains data store collections fields that may be used for filtering @@ -8581,6 +8814,10 @@ export namespace discoveryengine_v1alpha { * Whether or not to enable autocomplete. */ enableAutocomplete?: boolean | null; + /** + * Optional. If set to true, the widget will enable people search. + */ + enablePeopleSearch?: boolean | null; /** * Turn on or off collecting the search result quality feedback from end users. */ @@ -8676,6 +8913,52 @@ export namespace discoveryengine_v1alpha { */ type?: string | null; } + /** + * The specification for answer generation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpec { + /** + * Optional. The specification for user specified classifier spec. + */ + userDefinedClassifierSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec; + } + /** + * The specification for user defined classifier. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec { + /** + * Optional. Whether or not to enable and include user defined classifier. + */ + enableUserDefinedClassifier?: boolean | null; + /** + * Optional. The model id to be used for the user defined classifier. + */ + modelId?: string | null; + /** + * Optional. The preamble to be used for the user defined classifier. + */ + preamble?: string | null; + /** + * Optional. The seed value to be used for the user defined classifier. + */ + seed?: number | null; + /** + * Optional. The task marker to be used for the user defined classifier. + */ + taskMarker?: string | null; + /** + * Optional. The temperature value to be used for the user defined classifier. + */ + temperature?: number | null; + /** + * Optional. The top-k value to be used for the user defined classifier. + */ + topK?: string | null; + /** + * Optional. The top-p value to be used for the user defined classifier. + */ + topP?: number | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -8779,7 +9062,7 @@ export namespace discoveryengine_v1alpha { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -9047,6 +9330,10 @@ export namespace discoveryengine_v1alpha { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * 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. + */ + aclEnabled?: boolean | null; /** * Optional. Configuration for advanced site search. */ @@ -9353,7 +9640,28 @@ export namespace discoveryengine_v1alpha { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -9420,6 +9728,10 @@ export namespace discoveryengine_v1alpha { * 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. */ industryVertical?: string | null; + /** + * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. + */ + mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig; /** * 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. */ @@ -9493,6 +9805,75 @@ export namespace discoveryengine_v1alpha { */ companyName?: string | null; } + /** + * Additional config specs for a Media Recommendation engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig; + /** + * 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` + */ + optimizationObjective?: string | null; + /** + * 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). + */ + optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig; + /** + * 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. + */ + trainingState?: string | null; + /** + * 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 | null; + } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } + /** + * Custom threshold for `cvr` optimization_objective. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig { + /** + * Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. + */ + targetField?: string | null; + /** + * Required. The threshold to be applied to the target (e.g., 0.5). + */ + targetFieldValueFloat?: number | null; + } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Configurations for a Search Engine. */ @@ -10093,6 +10474,10 @@ export namespace discoveryengine_v1alpha { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -10131,7 +10516,7 @@ export namespace discoveryengine_v1alpha { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * 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. + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** @@ -10199,7 +10584,7 @@ export namespace discoveryengine_v1alpha { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * 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 + * 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_backend 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_backend 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; /** @@ -10260,7 +10645,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * 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. + * 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$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } @@ -10866,6 +11251,10 @@ export namespace discoveryengine_v1alpha { * Information of an end user. */ export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + /** + * Optional. IANA time zone, e.g. Europe/Budapest. + */ + timeZone?: string | null; /** * 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. */ @@ -10942,7 +11331,7 @@ export namespace discoveryengine_v1alpha { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -11197,6 +11586,10 @@ export namespace discoveryengine_v1alpha { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * 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. + */ + aclEnabled?: boolean | null; /** * Optional. Configuration for advanced site search. */ @@ -11487,7 +11880,28 @@ export namespace discoveryengine_v1alpha { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -11554,6 +11968,10 @@ export namespace discoveryengine_v1alpha { * 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. */ industryVertical?: string | null; + /** + * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. + */ + mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig; /** * 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. */ @@ -11627,6 +12045,75 @@ export namespace discoveryengine_v1alpha { */ companyName?: string | null; } + /** + * Additional config specs for a Media Recommendation engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig; + /** + * 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` + */ + optimizationObjective?: string | null; + /** + * 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). + */ + optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig; + /** + * 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. + */ + trainingState?: string | null; + /** + * 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 | null; + } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } + /** + * Custom threshold for `cvr` optimization_objective. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig { + /** + * Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. + */ + targetField?: string | null; + /** + * Required. The threshold to be applied to the target (e.g., 0.5). + */ + targetFieldValueFloat?: number | null; + } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Configurations for a Search Engine. */ @@ -11999,6 +12486,10 @@ export namespace discoveryengine_v1alpha { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -12163,6 +12654,10 @@ export namespace discoveryengine_v1alpha { * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. */ export interface Schema$GoogleCloudDiscoveryengineV1ServingConfig { + /** + * Optional. The specification for answer generation. + */ + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpec; /** * 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. */ @@ -12495,6 +12990,14 @@ export namespace discoveryengine_v1alpha { * Media upload request metadata. */ mediaRequestInfo?: Schema$ApiservingMediaRequestInfo; + /** + * The project (notebook) id of the uploaded source. Prefer to use the parent field instead. + */ + projectId?: string | null; + /** + * The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created. + */ + sourceId?: string | null; } /** * Response for the SourceService.UploadSourceFile method. @@ -15315,7 +15818,7 @@ export namespace discoveryengine_v1alpha { */ name?: string; /** - * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - destination_configs - blocking_reasons Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */ updateMask?: string; @@ -15341,6 +15844,105 @@ export namespace discoveryengine_v1alpha { ); } + /** + * Get the secret for the associated connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + options: StreamMethodOptions + ): GaxiosPromise; + getConnectorSecret( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + options?: MethodOptions + ): GaxiosPromise; + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + callback: BodyResponseCallback + ): void; + getConnectorSecret( + callback: BodyResponseCallback + ): void; + getConnectorSecret( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret; + 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}:getConnectorSecret').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 + ); + } + } + /** * Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced. * @@ -15441,6 +16043,13 @@ export namespace discoveryengine_v1alpha { } } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret + extends StandardParameters { + /** + * Required. The full resource name of the associated data connector. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun extends StandardParameters { /** @@ -17946,6 +18555,10 @@ export namespace discoveryengine_v1alpha { } export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument extends StandardParameters { + /** + * Optional. Specifies config for IMAGE_BYTES. + */ + imageId?: string; /** * 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. */ @@ -32583,6 +33196,10 @@ export namespace discoveryengine_v1alpha { } export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument extends StandardParameters { + /** + * Optional. Specifies config for IMAGE_BYTES. + */ + imageId?: string; /** * 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. */ diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 2e4c8f5b027..17ea0eb697f 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -476,6 +476,10 @@ export namespace discoveryengine_v1beta { * Output only. The connector contains the necessary parameters and is configured to support actions. */ isActionConfigured?: boolean | null; + /** + * Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. + */ + serviceName?: string | null; } /** * Configuration data for advance site search. @@ -1020,7 +1024,7 @@ export namespace discoveryengine_v1beta { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1alphaConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -1408,6 +1412,10 @@ export namespace discoveryengine_v1beta { * 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. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnector { + /** + * Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. + */ + aclEnabled?: boolean | null; /** * Optional. Action configurations to make the connector support actions. */ @@ -1428,6 +1436,10 @@ export namespace discoveryengine_v1beta { * Output only. User actions that must be completed before the connector can start syncing data. */ blockingReasons?: string[] | null; + /** + * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. + */ + connectorModes?: 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. */ @@ -1444,6 +1456,10 @@ export namespace discoveryengine_v1beta { * Optional. Any target destinations used to connect to third-party services. */ destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfig[]; + /** + * Optional. Any params and credentials used specifically for EUA connectors. + */ + endUserConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig; /** * List of entities from the connected data source to ingest. */ @@ -1492,6 +1508,10 @@ export namespace discoveryengine_v1beta { * Output only. real-time sync state */ realtimeState?: string | null; + /** + * Optional. The configuration for realtime sync. + */ + realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig; /** * 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. */ @@ -1517,6 +1537,32 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Any params and credentials used specifically for EUA connectors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig { + /** + * Optional. Any additional parameters needed for EUA. + */ + additionalParams?: {[key: string]: any} | null; + /** + * Optional. Any authentication parameters specific to EUA connectors. + */ + authParams?: {[key: string]: any} | null; + } + /** + * The configuration for realtime sync to store additional params for realtime sync. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig { + /** + * Optional. The ID of the Secret Manager secret used for webhook secret. + */ + realtimeSyncSecret?: string | null; + /** + * Optional. Webhook url for the connector to specify additional params for realtime sync. + */ + webhookUri?: string | null; + } /** * Represents an entity in the data source. For example, the `Account` object in Salesforce. */ @@ -1929,7 +1975,28 @@ export namespace discoveryengine_v1beta { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -2085,6 +2152,10 @@ export namespace discoveryengine_v1beta { * Additional config specs for a Media Recommendation engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig; /** * 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` */ @@ -2102,6 +2173,28 @@ export namespace discoveryengine_v1beta { */ type?: string | null; } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } /** * Custom threshold for `cvr` optimization_objective. */ @@ -2115,6 +2208,15 @@ export namespace discoveryengine_v1beta { */ targetFieldValueFloat?: number | null; } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Additional information of a recommendation engine. */ @@ -3106,6 +3208,10 @@ export namespace discoveryengine_v1beta { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -3148,7 +3254,7 @@ export namespace discoveryengine_v1beta { */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * 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. + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** @@ -3216,7 +3322,7 @@ export namespace discoveryengine_v1beta { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * 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 + * 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_backend 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_backend 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; /** @@ -3277,7 +3383,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec { /** - * 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. + * 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$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[]; } @@ -3997,6 +4103,10 @@ export namespace discoveryengine_v1beta { * Information of an end user. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfo { + /** + * Optional. IANA time zone, e.g. Europe/Budapest. + */ + timeZone?: string | null; /** * 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. */ @@ -4027,6 +4137,52 @@ export namespace discoveryengine_v1beta { */ type?: string | null; } + /** + * The specification for answer generation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpec { + /** + * Optional. The specification for user specified classifier spec. + */ + userDefinedClassifierSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec; + } + /** + * The specification for user defined classifier. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec { + /** + * Optional. Whether or not to enable and include user defined classifier. + */ + enableUserDefinedClassifier?: boolean | null; + /** + * Optional. The model id to be used for the user defined classifier. + */ + modelId?: string | null; + /** + * Optional. The preamble to be used for the user defined classifier. + */ + preamble?: string | null; + /** + * Optional. The seed value to be used for the user defined classifier. + */ + seed?: number | null; + /** + * Optional. The task marker to be used for the user defined classifier. + */ + taskMarker?: string | null; + /** + * Optional. The temperature value to be used for the user defined classifier. + */ + temperature?: number | null; + /** + * Optional. The top-k value to be used for the user defined classifier. + */ + topK?: string | null; + /** + * Optional. The top-p value to be used for the user defined classifier. + */ + topP?: number | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4057,6 +4213,10 @@ export namespace discoveryengine_v1beta { * Optional. Specification to boost suggestions matching the condition. */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec; + /** + * Optional. Experiment ids for this request. + */ + experimentIds?: string[] | null; /** * 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. */ @@ -4091,7 +4251,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec { /** - * 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. + * Condition boost specifications. If a suggestion matches multiple conditions in the specifications, 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. */ conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[]; } @@ -4409,6 +4569,52 @@ export namespace discoveryengine_v1beta { */ referenceId?: string | null; } + /** + * The specification for answer generation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec { + /** + * Optional. The specification for user specified classifier spec. + */ + userDefinedClassifierSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec; + } + /** + * The specification for user defined classifier. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec { + /** + * Optional. Whether or not to enable and include user defined classifier. + */ + enableUserDefinedClassifier?: boolean | null; + /** + * Optional. The model id to be used for the user defined classifier. + */ + modelId?: string | null; + /** + * Optional. The preamble to be used for the user defined classifier. + */ + preamble?: string | null; + /** + * Optional. The seed value to be used for the user defined classifier. + */ + seed?: number | null; + /** + * Optional. The task marker to be used for the user defined classifier. + */ + taskMarker?: string | null; + /** + * Optional. The temperature value to be used for the user defined classifier. + */ + temperature?: number | null; + /** + * Optional. The top-k value to be used for the user defined classifier. + */ + topK?: string | null; + /** + * Optional. The top-p value to be used for the user defined classifier. + */ + topP?: number | null; + } /** * Grounding support for a claim in `answer_text`. */ @@ -5400,6 +5606,10 @@ export namespace discoveryengine_v1beta { * 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. */ groundingCheckRequired?: boolean | null; + /** + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. + */ + score?: number | null; /** * 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). */ @@ -5413,11 +5623,19 @@ export namespace discoveryengine_v1beta { * 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. */ citationThreshold?: number | null; + /** + * The control flag that enables claim-level grounding score in the response. + */ + enableClaimLevelScore?: boolean | null; } /** * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. */ export interface Schema$GoogleCloudDiscoveryengineV1betaChunk { + /** + * Output only. Annotation contents if the current chunk contains annotations. + */ + annotationContents?: string[] | null; /** * Output only. Metadata of the current chunk. */ @@ -5426,6 +5644,10 @@ export namespace discoveryengine_v1beta { * Content is a string from a document (parsed content). */ content?: string | null; + /** + * Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUrls?: string[] | null; /** * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ @@ -5641,7 +5863,7 @@ export namespace discoveryengine_v1beta { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -6089,6 +6311,10 @@ export namespace discoveryengine_v1beta { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * 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. + */ + aclEnabled?: boolean | null; /** * Optional. Configuration for advanced site search. */ @@ -6333,7 +6559,11 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocument { /** - * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. + * Access control information for the document. + */ + aclInfo?: Schema$GoogleCloudDiscoveryengineV1betaDocumentAclInfo; + /** + * The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. */ content?: Schema$GoogleCloudDiscoveryengineV1betaDocumentContent; /** @@ -6373,12 +6603,34 @@ export namespace discoveryengine_v1beta { */ structData?: {[key: string]: any} | null; } + /** + * ACL Information of the Document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentAclInfo { + /** + * Readers of the document. + */ + readers?: Schema$GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction[]; + } + /** + * AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --\> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ] \} ] \} \} Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" \}, { "group_id": "group_3" \}, { "user_id": "user_2" \} ], \}, { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ], \} ] \} \} + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction { + /** + * All users within the Identity Provider. + */ + idpWide?: boolean | null; + /** + * List of principals. + */ + principals?: Schema$GoogleCloudDiscoveryengineV1betaPrincipal[]; + } /** * Unstructured data linked to this document. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentContent { /** - * 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. + * The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. */ mimeType?: string | null; /** @@ -6511,7 +6763,28 @@ export namespace discoveryengine_v1beta { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -6600,6 +6873,10 @@ export namespace discoveryengine_v1beta { * 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. */ industryVertical?: string | null; + /** + * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. + */ + mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig; /** * 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. */ @@ -6673,6 +6950,75 @@ export namespace discoveryengine_v1beta { */ companyName?: string | null; } + /** + * Additional config specs for a Media Recommendation engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig; + /** + * 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` + */ + optimizationObjective?: string | null; + /** + * 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). + */ + optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig; + /** + * 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. + */ + trainingState?: string | null; + /** + * 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 | null; + } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } + /** + * Custom threshold for `cvr` optimization_objective. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig { + /** + * Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. + */ + targetField?: string | null; + /** + * Required. The threshold to be applied to the target (e.g., 0.5). + */ + targetFieldValueFloat?: number | null; + } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } /** * Configurations for a Search Engine. */ @@ -6753,6 +7099,10 @@ export namespace discoveryengine_v1beta { * Text content of the fact chunk. Can be at most 10K characters long. */ chunkText?: string | null; + /** + * The domain of the source. + */ + domain?: string | null; /** * The index of this chunk. Currently, only used for the streaming mode. */ @@ -6765,6 +7115,14 @@ export namespace discoveryengine_v1beta { * More fine-grained information for the source reference. */ sourceMetadata?: {[key: string]: string} | null; + /** + * The title of the source. + */ + title?: string | null; + /** + * The URI of the source. + */ + uri?: string | null; } /** * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method. @@ -7379,6 +7737,15 @@ export namespace discoveryengine_v1beta { */ region?: string | null; } + /** + * Response message for CmekConfigService.ListCmekConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse { + /** + * All the customer's CmekConfigs. + */ + cmekConfigs?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig[]; + } /** * Response for ListControls method. */ @@ -7715,6 +8082,19 @@ export namespace discoveryengine_v1beta { * Request for pausing training of an engine. */ export interface Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest {} + /** + * Principal identifier of a user or a group. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPrincipal { + /** + * 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. + */ + 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 account, user_id is the mapped user identifier configured during the workforcepool config. + */ + userId?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -8377,6 +8757,10 @@ export namespace discoveryengine_v1beta { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -8415,7 +8799,7 @@ export namespace discoveryengine_v1beta { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * 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. + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** @@ -8483,7 +8867,7 @@ export namespace discoveryengine_v1beta { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * 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 + * 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_backend 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_backend 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; /** @@ -8544,7 +8928,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * 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. + * 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$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } @@ -9453,6 +9837,10 @@ export namespace discoveryengine_v1beta { * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. */ export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig { + /** + * Optional. The specification for answer generation. + */ + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec; /** * 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. */ @@ -10086,6 +10474,10 @@ export namespace discoveryengine_v1beta { * Information of an end user. */ export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + /** + * Optional. IANA time zone, e.g. Europe/Budapest. + */ + timeZone?: string | null; /** * 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. */ @@ -10162,7 +10554,7 @@ export namespace discoveryengine_v1beta { */ activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; /** - * 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. + * Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls. */ queryRegex?: string | null; /** @@ -10417,6 +10809,10 @@ export namespace discoveryengine_v1beta { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * 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. + */ + aclEnabled?: boolean | null; /** * Optional. Configuration for advanced site search. */ @@ -10707,7 +11103,28 @@ export namespace discoveryengine_v1beta { /** * The layout parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig { + /** + * Optional. If true, the LLM based annotation is added to the image during parsing. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. If true, the LLM based annotation is added to the table during parsing. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. List of HTML classes to exclude from the parsed content. + */ + excludeHtmlClasses?: string[] | null; + /** + * Optional. List of HTML elements to exclude from the parsed content. + */ + excludeHtmlElements?: string[] | null; + /** + * Optional. List of HTML ids to exclude from the parsed content. + */ + excludeHtmlIds?: string[] | null; + } /** * The OCR parsing configurations for documents. */ @@ -10774,6 +11191,10 @@ export namespace discoveryengine_v1beta { * 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. */ industryVertical?: string | null; + /** + * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. + */ + mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig; /** * 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. */ @@ -10848,7 +11269,76 @@ export namespace discoveryengine_v1beta { companyName?: string | null; } /** - * Configurations for a Search Engine. + * Additional config specs for a Media Recommendation engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig { + /** + * Optional. Additional engine features config. + */ + engineFeaturesConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig; + /** + * 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` + */ + optimizationObjective?: string | null; + /** + * 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). + */ + optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig; + /** + * 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. + */ + trainingState?: string | null; + /** + * 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 | null; + } + /** + * More feature configs of the selected engine type. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig { + /** + * Most popular engine feature config. + */ + mostPopularConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig; + /** + * Recommended for you engine feature config. + */ + recommendedForYouConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig; + } + /** + * Feature configurations that are required for creating a Most Popular engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig { + /** + * The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. + */ + timeWindowDays?: string | null; + } + /** + * Custom threshold for `cvr` optimization_objective. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig { + /** + * Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. + */ + targetField?: string | null; + /** + * Required. The threshold to be applied to the target (e.g., 0.5). + */ + targetFieldValueFloat?: number | null; + } + /** + * Additional feature configurations for creating a `recommended-for-you` engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig { + /** + * The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. + */ + contextEventType?: string | null; + } + /** + * Configurations for a Search Engine. */ export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { /** @@ -11219,6 +11709,10 @@ export namespace discoveryengine_v1beta { * Optional. The Promotion description. Maximum length: 200 characters. */ description?: string | null; + /** + * Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. + */ + document?: string | null; /** * 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. */ @@ -11383,6 +11877,10 @@ export namespace discoveryengine_v1beta { * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. */ export interface Schema$GoogleCloudDiscoveryengineV1ServingConfig { + /** + * Optional. The specification for answer generation. + */ + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerGenerationSpec; /** * 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. */ @@ -12039,6 +12537,7 @@ export namespace discoveryengine_v1beta { export class Resource$Projects$Locations { context: APIRequestContext; + cmekConfigs: Resource$Projects$Locations$Cmekconfigs; collections: Resource$Projects$Locations$Collections; dataStores: Resource$Projects$Locations$Datastores; evaluations: Resource$Projects$Locations$Evaluations; @@ -12051,6 +12550,9 @@ export namespace discoveryengine_v1beta { userEvents: Resource$Projects$Locations$Userevents; constructor(context: APIRequestContext) { this.context = context; + this.cmekConfigs = new Resource$Projects$Locations$Cmekconfigs( + this.context + ); this.collections = new Resource$Projects$Locations$Collections( this.context ); @@ -12080,6 +12582,101 @@ export namespace discoveryengine_v1beta { ); } + /** + * Gets the 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. + */ + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getCmekConfig( + params?: Params$Resource$Projects$Locations$Getcmekconfig, + options?: MethodOptions + ): GaxiosPromise; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + callback: BodyResponseCallback + ): void; + getCmekConfig( + callback: BodyResponseCallback + ): void; + getCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getcmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getcmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getcmekconfig; + 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 + ); + } + } + /** * 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. * @@ -12368,8 +12965,108 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + + /** + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected 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. + */ + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateCmekConfig( + params?: Params$Resource$Projects$Locations$Updatecmekconfig, + options?: MethodOptions + ): GaxiosPromise; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + callback: BodyResponseCallback + ): void; + updateCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updatecmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updatecmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updatecmekconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Projects$Locations$Getcmekconfig + extends StandardParameters { + /** + * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Obtaincrawlrate extends StandardParameters { /** @@ -12406,6 +13103,446 @@ export namespace discoveryengine_v1beta { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest; } + export interface Params$Resource$Projects$Locations$Updatecmekconfig + extends StandardParameters { + /** + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + */ + name?: string; + /** + * Set the following CmekConfig as the default to be used for child resources if one is not specified. + */ + setDefault?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig; + } + + export class Resource$Projects$Locations$Cmekconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + 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 + '/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 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. + */ + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all the CmekConfigs 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$Cmekconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Cmekconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$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}/cmekConfigs').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 + ); + } + } + + /** + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + 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 { + /** + * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$List + extends StandardParameters { + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch + extends StandardParameters { + /** + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + */ + name?: string; + /** + * Set the following CmekConfig as the default to be used for child resources if one is not specified. + */ + setDefault?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig; + } export class Resource$Projects$Locations$Collections { context: APIRequestContext; diff --git a/src/apis/displayvideo/v2.ts b/src/apis/displayvideo/v2.ts index 947e8ca473f..3aa7f7f0264 100644 --- a/src/apis/displayvideo/v2.ts +++ b/src/apis/displayvideo/v2.ts @@ -184,11 +184,11 @@ export namespace displayvideo_v2 { minimumVolume?: string | null; } /** - * Details of Adloox brand safety settings. + * Details of Scope3 (previously known as Adloox) brand safety settings. */ export interface Schema$Adloox { /** - * Adloox categories to exclude. + * Scope3 categories to exclude. */ excludedAdlooxCategories?: string[] | null; } @@ -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. *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). + * 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. This field can't be updated if 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. */ floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; /** @@ -3478,7 +3478,7 @@ export namespace displayvideo_v2 { */ 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). + * The conversion tracking setting of the line item. */ 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`. *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). + * 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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */ customBiddingAlgorithmId?: 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`. *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). + * 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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */ customBiddingAlgorithmId?: string | null; /** @@ -4871,7 +4871,7 @@ export namespace displayvideo_v2 { version?: string | null; } /** - * Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Type for the response returned by SdfDownloadTaskService.CreateSdfDownloadTask. */ export interface Schema$SdfDownloadTask { /** @@ -4880,7 +4880,7 @@ export namespace displayvideo_v2 { resourceName?: string | null; } /** - * Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Type for the metadata returned by SdfDownloadTaskService.CreateSdfDownloadTask. */ export interface Schema$SdfDownloadTaskMetadata { /** @@ -5232,7 +5232,7 @@ export namespace displayvideo_v2 { */ export interface Schema$ThirdPartyVerifierAssignedTargetingOptionDetails { /** - * Third party brand verifier -- Adloox. + * Third party brand verifier -- Scope3 (previously known as Adloox). */ adloox?: Schema$Adloox; /** @@ -15763,7 +15763,7 @@ export namespace displayvideo_v2 { } /** - * 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). + * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error. * * @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. *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). + * Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21488,7 +21488,7 @@ export namespace displayvideo_v2 { } /** - * 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. + * 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 `sdfdownloadtasks.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`. diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index bbb0b4bf963..8e9b1d97f4d 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -125,7 +125,6 @@ export namespace displayvideo_v3 { media: Resource$Media; partners: Resource$Partners; sdfdownloadtasks: Resource$Sdfdownloadtasks; - sdfuploadtasks: Resource$Sdfuploadtasks; targetingTypes: Resource$Targetingtypes; users: Resource$Users; @@ -153,7 +152,6 @@ 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); } @@ -308,7 +306,7 @@ export namespace displayvideo_v3 { assignedTargetingOption?: Schema$AssignedTargetingOption; } /** - * Details of Adloox brand safety settings. + * Details of Scope3 (previously known as Adloox) brand safety settings. */ export interface Schema$Adloox { /** @@ -338,11 +336,11 @@ export namespace displayvideo_v3 { */ displayIabViewability?: string | null; /** - * Adloox categories to exclude. + * Scope3 categories to exclude. */ excludedAdlooxCategories?: string[] | null; /** - * Optional. Adloox's fraud IVT MFA categories to exclude. + * Optional. Scope3's fraud IVT MFA categories to exclude. */ excludedFraudIvtMfaCategories?: string[] | null; /** @@ -565,10 +563,18 @@ export namespace displayvideo_v3 { * Rule-based algorithm. */ export interface Schema$AlgorithmRules { + /** + * Attribution model for the algorithm. + */ + attributionModelId?: string | null; /** * Rules for the impression signals. */ impressionSignalRuleset?: Schema$AlgorithmRulesRuleset; + /** + * Rules for the post-impression signals. + */ + postImpressionSignalRuleset?: Schema$AlgorithmRulesRuleset; } /** * A value to compare the signal to. @@ -614,6 +620,27 @@ export namespace displayvideo_v3 { * String value. */ stringValue?: string | null; + /** + * Video player size value. + */ + videoPlayerSizeValue?: string | null; + } + /** + * The rule to score impressions based on Floodlight conversion events. + */ + export interface Schema$AlgorithmRulesFloodlightActivityConversionSignal { + /** + * Required. The type of conversions to be used in impression value computation, for example, post-click conversions. + */ + conversionCounting?: string | null; + /** + * Required. The way to acquire value from the floodlight activity, for example, count of the conversion. + */ + countingMethod?: string | null; + /** + * Required. Id of the floodlight activity. + */ + floodlightActivityId?: 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. @@ -662,6 +689,14 @@ export namespace displayvideo_v3 { * Signal used to evaluate rules. */ export interface Schema$AlgorithmRulesSignal { + /** + * Signal based on active views. + */ + activeViewSignal?: string | null; + /** + * Signal based on clicks. + */ + clickSignal?: string | null; /** * Signal based on impressions. */ @@ -688,6 +723,14 @@ export namespace displayvideo_v3 { * Adjusted value of the signal used for rule evaluation. */ export interface Schema$AlgorithmRulesSignalValue { + /** + * Signal based on active views. Only `TIME_ON_SCREEN` is supported. + */ + activeViewSignal?: string | null; + /** + * Signal based on floodlight conversion events. + */ + floodlightActivityConversionSignal?: Schema$AlgorithmRulesFloodlightActivityConversionSignal; /** * Value to use as result. */ @@ -876,6 +919,10 @@ export namespace displayvideo_v3 { * Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. */ contentStreamTypeDetails?: Schema$ContentStreamTypeAssignedTargetingOptionDetails; + /** + * Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions. + */ + contentThemeExclusionDetails?: Schema$ContentThemeAssignedTargetingOptionDetails; /** * Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`. */ @@ -2088,12 +2135,38 @@ export namespace displayvideo_v3 { */ contentStreamType?: string | null; } + /** + * Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. + */ + export interface Schema$ContentThemeAssignedTargetingOptionDetails { + /** + * Output only. An enum for the DV360 content theme classifier. + */ + contentTheme?: string | null; + /** + * Required. An enum for the DV360 content theme classified to be EXCLUDED. + */ + excludedContentTheme?: string | null; + /** + * Required. ID of the content theme to be EXCLUDED. + */ + excludedTargetingOptionId?: string | null; + } + /** + * Represents a targetable content theme. This will be populated in the content_theme_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. + */ + export interface Schema$ContentThemeTargetingOptionDetails { + /** + * Output only. An enum for the DV360 content theme content classifier. + */ + contentTheme?: 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). + * 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. This field can't be updated if 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. */ floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; /** @@ -3141,7 +3214,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` *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). + * The duration in days that an entry remains in the audience after the qualifying event. 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` */ membershipDurationDays?: string | null; /** @@ -4134,7 +4207,7 @@ export namespace displayvideo_v3 { */ 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). + * The conversion tracking setting of the line item. */ conversionCounting?: Schema$ConversionCountingConfig; /** @@ -4742,7 +4815,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`. *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). + * 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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */ customBiddingAlgorithmId?: string | null; /** @@ -5237,7 +5310,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`. *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). + * 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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */ customBiddingAlgorithmId?: string | null; /** @@ -5553,7 +5626,7 @@ export namespace displayvideo_v3 { version?: string | null; } /** - * Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Type for the response returned by SdfDownloadTaskService.CreateSdfDownloadTask. */ export interface Schema$SdfDownloadTask { /** @@ -5562,7 +5635,7 @@ export namespace displayvideo_v3 { resourceName?: string | null; } /** - * Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Type for the metadata returned by SdfDownloadTaskService.CreateSdfDownloadTask. */ export interface Schema$SdfDownloadTaskMetadata { /** @@ -5785,6 +5858,10 @@ export namespace displayvideo_v3 { * Content stream type resource details. */ contentStreamTypeDetails?: Schema$ContentStreamTypeTargetingOptionDetails; + /** + * Content theme details. + */ + contentThemeDetails?: Schema$ContentThemeTargetingOptionDetails; /** * Device make and model resource details. */ @@ -5939,7 +6016,7 @@ export namespace displayvideo_v3 { */ export interface Schema$ThirdPartyVerifierAssignedTargetingOptionDetails { /** - * Third party brand verifier -- Adloox. + * Third party brand verifier -- Scope3 (previously known as Adloox). */ adloox?: Schema$Adloox; /** @@ -16699,7 +16776,7 @@ export namespace displayvideo_v3 { } /** - * 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). + * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17087,7 +17164,7 @@ export namespace displayvideo_v3 { } /** - * 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). + * Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17454,7 +17531,7 @@ export namespace displayvideo_v3 { } /** - * 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). + * Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23481,7 +23558,7 @@ export namespace displayvideo_v3 { } /** - * 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. + * 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 `sdfdownloadtasks.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`. @@ -23677,115 +23754,6 @@ 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 de106dfde5f..1ea24be706f 100644 --- a/src/apis/displayvideo/v4.ts +++ b/src/apis/displayvideo/v4.ts @@ -308,7 +308,7 @@ export namespace displayvideo_v4 { assignedTargetingOption?: Schema$AssignedTargetingOption; } /** - * Details of Adloox brand safety settings. + * Details of Scope3 (previously known as Adloox) brand safety settings. */ export interface Schema$Adloox { /** @@ -338,11 +338,11 @@ export namespace displayvideo_v4 { */ displayIabViewability?: string | null; /** - * Adloox categories to exclude. + * Scope3 categories to exclude. */ excludedAdlooxCategories?: string[] | null; /** - * Optional. Adloox's fraud IVT MFA categories to exclude. + * Optional. Scope3's fraud IVT MFA categories to exclude. */ excludedFraudIvtMfaCategories?: string[] | null; /** @@ -565,10 +565,18 @@ export namespace displayvideo_v4 { * Rule-based algorithm. */ export interface Schema$AlgorithmRules { + /** + * Attribution model for the algorithm. + */ + attributionModelId?: string | null; /** * Rules for the impression signals. */ impressionSignalRuleset?: Schema$AlgorithmRulesRuleset; + /** + * Rules for the post-impression signals. + */ + postImpressionSignalRuleset?: Schema$AlgorithmRulesRuleset; } /** * A value to compare the signal to. @@ -614,6 +622,27 @@ export namespace displayvideo_v4 { * String value. */ stringValue?: string | null; + /** + * Video player size value. + */ + videoPlayerSizeValue?: string | null; + } + /** + * The rule to score impressions based on Floodlight conversion events. + */ + export interface Schema$AlgorithmRulesFloodlightActivityConversionSignal { + /** + * Required. The type of conversions to be used in impression value computation, for example, post-click conversions. + */ + conversionCounting?: string | null; + /** + * Required. The way to acquire value from the floodlight activity, for example, count of the conversion. + */ + countingMethod?: string | null; + /** + * Required. Id of the floodlight activity. + */ + floodlightActivityId?: 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. @@ -662,6 +691,14 @@ export namespace displayvideo_v4 { * Signal used to evaluate rules. */ export interface Schema$AlgorithmRulesSignal { + /** + * Signal based on active views. + */ + activeViewSignal?: string | null; + /** + * Signal based on clicks. + */ + clickSignal?: string | null; /** * Signal based on impressions. */ @@ -688,6 +725,14 @@ export namespace displayvideo_v4 { * Adjusted value of the signal used for rule evaluation. */ export interface Schema$AlgorithmRulesSignalValue { + /** + * Signal based on active views. Only `TIME_ON_SCREEN` is supported. + */ + activeViewSignal?: string | null; + /** + * Signal based on floodlight conversion events. + */ + floodlightActivityConversionSignal?: Schema$AlgorithmRulesFloodlightActivityConversionSignal; /** * Value to use as result. */ @@ -876,6 +921,10 @@ export namespace displayvideo_v4 { * Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. */ contentStreamTypeDetails?: Schema$ContentStreamTypeAssignedTargetingOptionDetails; + /** + * Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions. + */ + contentThemeExclusionDetails?: Schema$ContentThemeAssignedTargetingOptionDetails; /** * Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`. */ @@ -2068,12 +2117,38 @@ export namespace displayvideo_v4 { */ contentStreamType?: string | null; } + /** + * Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. + */ + export interface Schema$ContentThemeAssignedTargetingOptionDetails { + /** + * Output only. An enum for the DV360 content theme classifier. + */ + contentTheme?: string | null; + /** + * Required. An enum for the DV360 content theme classified to be EXCLUDED. + */ + excludedContentTheme?: string | null; + /** + * Required. ID of the content theme to be EXCLUDED. + */ + excludedTargetingOptionId?: string | null; + } + /** + * Represents a targetable content theme. This will be populated in the content_theme_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. + */ + export interface Schema$ContentThemeTargetingOptionDetails { + /** + * Output only. An enum for the DV360 content theme content classifier. + */ + contentTheme?: 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). + * 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. This field can't be updated if 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. */ floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; /** @@ -3121,7 +3196,7 @@ export namespace displayvideo_v4 { */ 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). + * Output only. The duration in days that an entry remains in the audience after the qualifying event. 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` */ membershipDurationDays?: string | null; /** @@ -4114,7 +4189,7 @@ export namespace displayvideo_v4 { */ 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). + * The conversion tracking setting of the line item. */ conversionCounting?: Schema$ConversionCountingConfig; /** @@ -4699,7 +4774,7 @@ export namespace displayvideo_v4 { */ 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). + * 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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */ customBiddingAlgorithmId?: string | null; /** @@ -5194,7 +5269,7 @@ export namespace displayvideo_v4 { */ 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). + * 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`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */ customBiddingAlgorithmId?: string | null; /** @@ -5493,7 +5568,7 @@ export namespace displayvideo_v4 { version?: string | null; } /** - * Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Type for the response returned by SdfDownloadTaskService.CreateSdfDownloadTask. */ export interface Schema$SdfDownloadTask { /** @@ -5502,7 +5577,7 @@ export namespace displayvideo_v4 { resourceName?: string | null; } /** - * Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Type for the metadata returned by SdfDownloadTaskService.CreateSdfDownloadTask. */ export interface Schema$SdfDownloadTaskMetadata { /** @@ -5725,6 +5800,10 @@ export namespace displayvideo_v4 { * Content stream type resource details. */ contentStreamTypeDetails?: Schema$ContentStreamTypeTargetingOptionDetails; + /** + * Content theme details. + */ + contentThemeDetails?: Schema$ContentThemeTargetingOptionDetails; /** * Device make and model resource details. */ @@ -5879,7 +5958,7 @@ export namespace displayvideo_v4 { */ export interface Schema$ThirdPartyVerifierAssignedTargetingOptionDetails { /** - * Third party brand verifier -- Adloox. + * Third party brand verifier -- Scope3 (previously known as Adloox). */ adloox?: Schema$Adloox; /** @@ -15604,7 +15683,7 @@ export namespace displayvideo_v4 { } /** - * 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). + * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15992,7 +16071,7 @@ export namespace displayvideo_v4 { } /** - * 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). + * Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16359,7 +16438,7 @@ export namespace displayvideo_v4 { } /** - * 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). + * Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22392,7 +22471,7 @@ export namespace displayvideo_v4 { } /** - * 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. + * 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 `sdfdownloadtasks.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`. diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index fd3aac28a9e..4b5f13aa6b5 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -2475,7 +2475,7 @@ export namespace dlp_v2 { */ fileStoreInfoTypeSummaries?: Schema$GooglePrivacyDlpV2FileStoreInfoTypeSummary[]; /** - * The file store does not have any files. + * The file store does not have any files. If the profiling failed, this will be false. */ fileStoreIsEmpty?: boolean | null; /** diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 1cd70b9eb8f..0eae6a06563 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -514,6 +514,10 @@ export namespace dns_v1 { targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[]; } export interface Schema$ManagedZoneForwardingConfigNameServerTarget { + /** + * Fully qualified domain name for the forwarding target. + */ + domainName?: string | null; /** * Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target. */ diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 22c47be14a0..d89737ad869 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -514,6 +514,10 @@ export namespace dns_v1beta2 { targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[]; } export interface Schema$ManagedZoneForwardingConfigNameServerTarget { + /** + * Fully qualified domain name for the forwarding target. + */ + domainName?: string | null; /** * Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target. */ diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 4b9f66fafbb..fd8323c0381 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -2680,6 +2680,10 @@ export namespace docs_v1 { * Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive. */ matchCase?: boolean | null; + /** + * Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching. + */ + searchByRegex?: boolean | null; /** * The text to search for in the document. */ diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index 46d8268389d..51e6701a814 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -1500,6 +1500,10 @@ export namespace documentai_v1 { * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ content?: string | null; + /** + * Optional. An internal identifier for document. Should be loggable (no PII). + */ + docid?: string | null; /** * Parsed layout of the document. */ @@ -1643,6 +1647,10 @@ export namespace documentai_v1 { * ID of the block. */ blockId?: string | null; + /** + * Identifies the bounding box for the block. + */ + boundingBox?: Schema$GoogleCloudDocumentaiV1BoundingPoly; /** * Block consisting of list content/structure. */ @@ -1836,6 +1844,7 @@ export namespace documentai_v1 { * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */ moneyValue?: Schema$GoogleTypeMoney; + signatureValue?: boolean | null; /** * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. */ @@ -2555,6 +2564,10 @@ export namespace documentai_v1 { * User defined name for the property. */ displayName?: string | null; + /** + * Grounding config of the entity type. + */ + groundingConfig?: string | null; /** * The name of the property. Follows the same guidelines as the EntityType name. */ @@ -3862,15 +3875,15 @@ export namespace documentai_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 + * 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 or 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -3878,7 +3891,7 @@ export namespace documentai_v1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -3886,7 +3899,7 @@ export namespace documentai_v1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -3902,11 +3915,11 @@ export namespace documentai_v1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } @@ -4359,6 +4372,10 @@ export namespace documentai_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index f24750fa6de..c36641e2bb2 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -1189,6 +1189,10 @@ export namespace documentai_v1beta3 { * Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. */ export interface Schema$GoogleCloudDocumentaiV1beta3Document { + /** + * Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id. + */ + blobAssets?: Schema$GoogleCloudDocumentaiV1beta3DocumentBlobAsset[]; /** * Document chunked based on chunking config. */ @@ -1197,6 +1201,10 @@ export namespace documentai_v1beta3 { * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ content?: string | null; + /** + * Optional. An internal identifier for document. Should be loggable (no PII). + */ + docid?: string | null; /** * Parsed layout of the document. */ @@ -1246,6 +1254,32 @@ export namespace documentai_v1beta3 { */ uri?: string | null; } + /** + * Represents the annotation of a block or a chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations { + /** + * The description of the content with this annotation. + */ + description?: string | null; + } + /** + * Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentBlobAsset { + /** + * Optional. The id of the blob asset. + */ + assetId?: string | null; + /** + * Optional. The content of the blob asset, e.g. image bytes. + */ + content?: string | null; + /** + * The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + */ + mimeType?: string | null; + } /** * Represents the chunks that the document is divided into. */ @@ -1259,6 +1293,10 @@ export namespace documentai_v1beta3 { * Represents a chunk. */ export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk { + /** + * Chunk fields inside this chunk. + */ + chunkFields?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField[]; /** * ID of the chunk. */ @@ -1284,6 +1322,19 @@ export namespace documentai_v1beta3 { */ sourceBlockIds?: string[] | null; } + /** + * The chunk field in the chunk. A chunk field could be one of the various types (e.g. image, table) supported. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField { + /** + * The image chunk field in the chunk. + */ + imageChunkField?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField; + /** + * The table chunk field in the chunk. + */ + tableChunkField?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField; + } /** * Represents the page footer associated with the chunk. */ @@ -1323,6 +1374,36 @@ export namespace documentai_v1beta3 { */ pageStart?: number | null; } + /** + * The image chunk field in the chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField { + /** + * Annotation of the image chunk field. + */ + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; + /** + * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. + */ + blobAssetId?: string | null; + /** + * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUri?: string | null; + /** + * Optional. Google Cloud Storage uri of the image. + */ + gcsUri?: string | null; + } + /** + * The table chunk field in the chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField { + /** + * Annotation of the table chunk field. + */ + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; + } /** * Represents the parsed layout of a document as a collection of blocks that the document is divided into. */ @@ -1340,6 +1421,14 @@ export namespace documentai_v1beta3 { * ID of the block. */ blockId?: string | null; + /** + * Identifies the bounding box for the block. + */ + boundingBox?: Schema$GoogleCloudDocumentaiV1beta3BoundingPoly; + /** + * Block consisting of image content. + */ + imageBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock; /** * Block consisting of list content/structure. */ @@ -1357,6 +1446,35 @@ export namespace documentai_v1beta3 { */ textBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; } + /** + * Represents an image type block. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock { + /** + * Annotation of the image block. + */ + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; + /** + * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. + */ + blobAssetId?: string | null; + /** + * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUri?: string | null; + /** + * Optional. Google Cloud Storage uri of the image. + */ + gcsUri?: string | null; + /** + * Text extracted from the image using OCR or alt text describing the image. + */ + imageText?: string | null; + /** + * Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). + */ + mimeType?: string | null; + } /** * Represents a list type block. */ @@ -1396,6 +1514,10 @@ export namespace documentai_v1beta3 { * Represents a table type block. */ export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { + /** + * Annotation of the table block. + */ + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; /** * Body rows containing main table content. */ @@ -1533,6 +1655,7 @@ export namespace documentai_v1beta3 { * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */ moneyValue?: Schema$GoogleTypeMoney; + signatureValue?: boolean | null; /** * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. */ @@ -2328,6 +2451,10 @@ export namespace documentai_v1beta3 { * User defined name for the property. */ displayName?: string | null; + /** + * Grounding config of the entity type. + */ + groundingConfig?: string | null; /** * The name of the property. Follows the same guidelines as the EntityType name. */ @@ -3113,6 +3240,22 @@ export namespace documentai_v1beta3 { * Optional. Config for chunking in layout parser processor. */ chunkingConfig?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig; + /** + * Optional. Whether to include image annotations in layout parser response. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. Whether to extract images in layout parser response. + */ + enableImageExtraction?: boolean | null; + /** + * Optional. Whether to refine PDF layout using LLM. + */ + enableLlmLayoutParsing?: boolean | null; + /** + * Optional. Whether to include table annotations in layout parser response. + */ + enableTableAnnotation?: boolean | null; /** * Optional. Whether to include bounding boxes in layout parser processor response. */ @@ -4132,15 +4275,15 @@ export namespace documentai_v1beta3 { 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 + * 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 or 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -4148,7 +4291,7 @@ export namespace documentai_v1beta3 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -4156,7 +4299,7 @@ export namespace documentai_v1beta3 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -4172,11 +4315,11 @@ export namespace documentai_v1beta3 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } @@ -4524,6 +4667,10 @@ export namespace documentai_v1beta3 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 482dfd31425..cab48fac34d 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -601,7 +601,7 @@ export namespace drive_v2 { */ export interface Schema$Comment { /** - * A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + * A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/workspace/drive/api/v2/manage-comments). */ anchor?: string | null; /** @@ -1944,7 +1944,7 @@ export namespace drive_v2 { */ displayName?: string | null; /** - * Output only. The email address of the user. + * Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. */ emailAddress?: string | null; /** @@ -1952,11 +1952,11 @@ export namespace drive_v2 { */ isAuthenticatedUser?: boolean | null; /** - * Output only. This is always `drive#user`. + * Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. */ kind?: string | null; /** - * Output only. The user's ID as visible in the permissions collection. + * Output only. The user's ID as visible in Permission resources. */ permissionId?: string | null; /** @@ -4277,7 +4277,7 @@ export namespace drive_v2 { } /** - * Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide. + * Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/workspace/drive/api/guides/search-shareddrives) guide. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5053,7 +5053,7 @@ export namespace drive_v2 { } /** - * Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads). + * Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5140,7 +5140,7 @@ export namespace drive_v2 { } /** - * Inserts a new file. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. + * Inserts a new file. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5228,7 +5228,7 @@ export namespace drive_v2 { } /** - * Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. + * Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5842,7 +5842,7 @@ export namespace drive_v2 { } /** - * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). + * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index c19b345348f..99e142b22d3 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -520,7 +520,7 @@ export namespace drive_v3 { */ export interface Schema$Comment { /** - * A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/drive/api/v3/manage-comments). + * A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). */ anchor?: string | null; /** @@ -1322,7 +1322,7 @@ export namespace drive_v3 { response?: {[key: string]: any} | null; } /** - * A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. + * A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. */ export interface Schema$Permission { /** @@ -1714,7 +1714,7 @@ export namespace drive_v3 { */ emailAddress?: string | null; /** - * Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. + * Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. */ kind?: string | null; /** @@ -1738,7 +1738,7 @@ export namespace drive_v3 { } /** - * Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/drive/api/guides/user-info). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter). + * Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2149,7 +2149,7 @@ export namespace drive_v3 { } /** - * Gets a specific app. For more information, see [Return user info](https://developers.google.com/drive/api/guides/user-info). + * Gets a specific app. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2236,7 +2236,7 @@ export namespace drive_v3 { } /** - * Lists a user's installed apps. For more information, see [Return user info](https://developers.google.com/drive/api/guides/user-info). + * Lists a user's installed apps. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2348,7 +2348,7 @@ export namespace drive_v3 { } /** - * Gets the starting pageToken for listing future changes. For more information, see [Retrieve changes](https://developers.google.com/drive/api/guides/manage-changes). + * Gets the starting pageToken for listing future changes. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2438,7 +2438,7 @@ export namespace drive_v3 { } /** - * Lists the changes for a user or shared drive. For more information, see [Retrieve changes](https://developers.google.com/drive/api/guides/manage-changes). + * Lists the changes for a user or shared drive. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2522,7 +2522,7 @@ export namespace drive_v3 { } /** - * Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/drive/api/guides/push). + * Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2757,7 +2757,7 @@ export namespace drive_v3 { } /** - * Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/drive/api/guides/push). + * Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2856,7 +2856,7 @@ export namespace drive_v3 { } /** - * Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter). + * Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2943,7 +2943,7 @@ export namespace drive_v3 { } /** - * Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter). + * Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3027,7 +3027,7 @@ export namespace drive_v3 { } /** - * Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter). + * Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3113,7 +3113,7 @@ export namespace drive_v3 { } /** - * Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter). + * Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3200,7 +3200,7 @@ export namespace drive_v3 { } /** - * Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/drive/api/guides/fields-parameter). + * Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3709,7 +3709,7 @@ export namespace drive_v3 { } /** - * Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide. + * Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/workspace/drive/api/guides/search-shareddrives) guide. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4142,7 +4142,7 @@ export namespace drive_v3 { } /** - * Creates a new file. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. + * Creates a new file. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4660,7 +4660,7 @@ export namespace drive_v3 { } /** - * Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads). + * Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/workspace/drive/api/guides/manage-downloads). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4747,7 +4747,7 @@ export namespace drive_v3 { } /** - * Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. + * Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/workspace/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5013,7 +5013,7 @@ export namespace drive_v3 { } /** - * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). + * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an x/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`x/x` Note: Specify a valid MIME type, rather than the literal `x/x` value. The literal `x/x` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/driveactivity/v2.ts b/src/apis/driveactivity/v2.ts index 98a10c7b3f3..89b794092a2 100644 --- a/src/apis/driveactivity/v2.ts +++ b/src/apis/driveactivity/v2.ts @@ -475,7 +475,7 @@ export namespace driveactivity_v2 { */ folder?: Schema$Folder; /** - * The MIME type of the Drive item. See https://developers.google.com/drive/v3/web/mime-types. + * The MIME type of the Drive item. See https://developers.google.com/workspace/drive/v3/web/mime-types. */ mimeType?: string | null; /** @@ -604,11 +604,11 @@ export namespace driveactivity_v2 { */ export interface Schema$FileComment { /** - * The comment in the discussion thread. This identifier is an opaque string compatible with the Drive API; see https://developers.google.com/drive/v3/reference/comments/get + * The comment in the discussion thread. This identifier is an opaque string compatible with the Drive API; see https://developers.google.com/workspace/drive/v3/reference/comments/get */ legacyCommentId?: string | null; /** - * The discussion thread to which the comment was added. This identifier is an opaque string compatible with the Drive API and references the first comment in a discussion; see https://developers.google.com/drive/v3/reference/comments/get + * The discussion thread to which the comment was added. This identifier is an opaque string compatible with the Drive API and references the first comment in a discussion; see https://developers.google.com/workspace/drive/v3/reference/comments/get */ legacyDiscussionId?: string | null; /** @@ -740,7 +740,7 @@ export namespace driveactivity_v2 { */ group?: Schema$Group; /** - * Indicates the [Google Drive permissions role](https://developers.google.com/drive/web/manage-sharing#roles). The role determines a user's ability to read, write, and comment on items. + * Indicates the [Google Drive permissions role](https://developers.google.com/workspace/drive/web/manage-sharing#roles). The role determines a user's ability to read, write, and comment on items. */ role?: string | null; /** @@ -906,7 +906,7 @@ export namespace driveactivity_v2 { type?: string | null; } /** - * Information about the target of activity. For more information on how activity history is shared with users, see [Activity history visibility](https://developers.google.com/drive/activity/v2#activityhistory). + * Information about the target of activity. For more information on how activity history is shared with users, see [Activity history visibility](https://developers.google.com/workspace/drive/activity/v2#activityhistory). */ export interface Schema$Target { /** diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index 084436f5c47..55f57aa1a81 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -332,7 +332,7 @@ export namespace eventarc_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project\}/locations/{location\}/messageBuses/{messageBus\}. + * Required. Immutable. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project\}/locations/{location\}/messageBuses/{messageBus\}. */ messageBus?: string | null; /** @@ -1696,6 +1696,10 @@ export namespace eventarc_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 62ed744400b..28886089a8f 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -286,6 +286,10 @@ export namespace file_v1 { * consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites). */ consumerDefinedName?: string | null; + /** + * Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required. + */ + consumerProjectNumber?: string | null; /** * Output only. Timestamp when the resource was created. */ @@ -1271,13 +1275,13 @@ export namespace file_v1 { 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). + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. */ - filter?: string; + extraLocationTypes?: string[]; /** - * If true, the returned list will include locations which are not yet revealed. + * 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). */ - includeUnrevealedLocations?: boolean; + filter?: string; /** * The resource that owns the locations collection, if applicable. */ diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 7898bfabee2..59a3785097d 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -245,9 +245,13 @@ export namespace file_v1beta1 { time?: Schema$TimeOfDay; } /** - * Directory Services configuration for Kerberos-based authentication. + * Directory Services configuration. */ export interface Schema$DirectoryServicesConfig { + /** + * Configuration for LDAP servers. + */ + ldap?: Schema$LdapConfig; /** * Configuration for Managed Service for Microsoft Active Directory. */ @@ -295,6 +299,10 @@ export namespace file_v1beta1 { * consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites). */ consumerDefinedName?: string | null; + /** + * Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required. + */ + consumerProjectNumber?: string | null; /** * Output only. Timestamp when the resource was created. */ @@ -525,7 +533,7 @@ export namespace file_v1beta1 { */ description?: string | null; /** - * Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". + * Optional. Directory Services configuration. Should only be set if protocol is "NFS_V4_1". */ directoryServices?: Schema$DirectoryServicesConfig; /** @@ -618,6 +626,27 @@ export namespace file_v1beta1 { */ maxIopsPerTb?: string | null; } + /** + * LdapConfig contains all the parameters for connecting to LDAP servers. + */ + export interface Schema$LdapConfig { + /** + * Required. The LDAP domain name in the format of `my-domain.com`. + */ + domain?: string | null; + /** + * Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + */ + groupsOu?: string | null; + /** + * Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses. + */ + servers?: string[] | null; + /** + * Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + */ + usersOu?: string | null; + } /** * ListBackupsResponse is the result of ListBackupsRequest. */ @@ -816,6 +845,10 @@ export namespace file_v1beta1 { * The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. */ network?: string | null; + /** + * Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. + */ + pscConfig?: Schema$PscConfig; /** * Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. */ @@ -841,6 +874,10 @@ export namespace file_v1beta1 { * List of either an IPv4 addresses in the format `{octet1\}.{octet2\}.{octet3\}.{octet4\}` or CIDR ranges in the format `{octet1\}.{octet2\}.{octet3\}.{octet4\}/{mask size\}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. */ ipRanges?: string[] | null; + /** + * Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field. + */ + network?: string | null; /** * The security flavors allowed for mount operations. The default is AUTH_SYS. */ @@ -955,6 +992,15 @@ export namespace file_v1beta1 { */ peerInstance?: string | null; } + /** + * Private Service Connect configuration. + */ + export interface Schema$PscConfig { + /** + * Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. + */ + endpointProject?: string | null; + } /** * Replica configuration for the instance. */ @@ -1383,13 +1429,13 @@ export namespace file_v1beta1 { 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). + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. */ - filter?: string; + extraLocationTypes?: string[]; /** - * If true, the returned list will include locations which are not yet revealed. + * 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). */ - includeUnrevealedLocations?: boolean; + filter?: string; /** * The resource that owns the locations collection, if applicable. */ diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index f9c7d1e7687..cd53b483a7b 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -504,6 +504,9 @@ export namespace firebase_v1beta1 { */ type?: string | null; } + /** + * This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ export interface Schema$MessageSet {} /** * This resource represents a long-running operation that is the result of a network API call. diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index 52bc8e891b3..be63bece1f2 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -150,9 +150,6 @@ export namespace firebaseappdistribution_v1alpha { */ certificateHashSha256?: string | null; } - /** - * Instructions for AI driven test - */ export interface Schema$GoogleFirebaseAppdistroV1alphaAiInstructions { /** * Required. Steps to be accomplished by the AI @@ -579,10 +576,6 @@ export namespace firebaseappdistribution_v1alpha { */ usernameResourceName?: string | null; } - /** - * The response message for `ProvisionApp`. - */ - export interface Schema$GoogleFirebaseAppdistroV1alphaProvisionAppResponse {} /** * Proto defining a release object */ @@ -1114,104 +1107,6 @@ export namespace firebaseappdistribution_v1alpha { ); } } - - /** - * Provision app distribution for an existing Firebase app, enabling it to subsequently be used by appdistro. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - provisionApp( - params: Params$Resource$Apps$Provisionapp, - options: StreamMethodOptions - ): GaxiosPromise; - provisionApp( - params?: Params$Resource$Apps$Provisionapp, - options?: MethodOptions - ): GaxiosPromise; - provisionApp( - params: Params$Resource$Apps$Provisionapp, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - provisionApp( - params: Params$Resource$Apps$Provisionapp, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - provisionApp( - params: Params$Resource$Apps$Provisionapp, - callback: BodyResponseCallback - ): void; - provisionApp( - callback: BodyResponseCallback - ): void; - provisionApp( - paramsOrCallback?: - | Params$Resource$Apps$Provisionapp - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Apps$Provisionapp; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Apps$Provisionapp; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://firebaseappdistribution.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/apps/{mobilesdkAppId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['mobilesdkAppId'], - pathParams: ['mobilesdkAppId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } } export interface Params$Resource$Apps$Get extends StandardParameters { @@ -1230,13 +1125,6 @@ export namespace firebaseappdistribution_v1alpha { */ mobilesdkAppId?: string; } - export interface Params$Resource$Apps$Provisionapp - extends StandardParameters { - /** - * Unique id for a Firebase app of the format: {version\}:{project_number\}:{platform\}:{hash(bundle_id)\} Example: 1:581234567376:android:aa0a3c7b135e90289 - */ - mobilesdkAppId?: string; - } export class Resource$Apps$Releases { context: APIRequestContext; @@ -2054,7 +1942,7 @@ export namespace firebaseappdistribution_v1alpha { } /** - * Updates a release. + * Updates automated test configuration. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/firebasedataconnect/index.ts b/src/apis/firebasedataconnect/index.ts index 7853e5dad0c..8db541eb0a8 100644 --- a/src/apis/firebasedataconnect/index.ts +++ b/src/apis/firebasedataconnect/index.ts @@ -14,12 +14,20 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {firebasedataconnect_v1} from './v1'; import {firebasedataconnect_v1beta} from './v1beta'; export const VERSIONS = { + v1: firebasedataconnect_v1.Firebasedataconnect, v1beta: firebasedataconnect_v1beta.Firebasedataconnect, }; +export function firebasedataconnect( + version: 'v1' +): firebasedataconnect_v1.Firebasedataconnect; +export function firebasedataconnect( + options: firebasedataconnect_v1.Options +): firebasedataconnect_v1.Firebasedataconnect; export function firebasedataconnect( version: 'v1beta' ): firebasedataconnect_v1beta.Firebasedataconnect; @@ -27,16 +35,23 @@ export function firebasedataconnect( options: firebasedataconnect_v1beta.Options ): firebasedataconnect_v1beta.Firebasedataconnect; export function firebasedataconnect< - T = firebasedataconnect_v1beta.Firebasedataconnect, + T = + | firebasedataconnect_v1.Firebasedataconnect + | firebasedataconnect_v1beta.Firebasedataconnect, >( this: GoogleConfigurable, - versionOrOptions: 'v1beta' | firebasedataconnect_v1beta.Options + versionOrOptions: + | 'v1' + | firebasedataconnect_v1.Options + | 'v1beta' + | firebasedataconnect_v1beta.Options ) { return getAPI('firebasedataconnect', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); export {auth}; +export {firebasedataconnect_v1}; export {firebasedataconnect_v1beta}; export { AuthPlus, diff --git a/src/apis/firebasedataconnect/v1.ts b/src/apis/firebasedataconnect/v1.ts new file mode 100644 index 00000000000..c3d78e89b86 --- /dev/null +++ b/src/apis/firebasedataconnect/v1.ts @@ -0,0 +1,3415 @@ +// 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 firebasedataconnect_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; + } + + /** + * Firebase Data Connect API + * + * Firebase Data Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered by Cloud SQL. The REST API lets developers manage the connections to their database, change the schema of their database, and query the database. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const firebasedataconnect = google.firebasedataconnect('v1'); + * ``` + */ + export class Firebasedataconnect { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * Settings for CloudSQL instance configuration. + */ + export interface Schema$CloudSqlInstance { + /** + * Required. Name of the CloudSQL instance, in the format: ``` projects/{project\}/locations/{location\}/instances/{instance\} ``` + */ + instance?: string | null; + } + /** + * Connector consists of a set of operations, i.e. queries and mutations. + */ + export interface Schema$Connector { + /** + * Optional. Stores small amounts of arbitrary data. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. [Output only] Create time stamp. + */ + createTime?: string | null; + /** + * Optional. Mutable human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Output only. 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. [AIP-154](https://google.aip.dev/154) + */ + etag?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The relative resource name of the connector, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string | null; + /** + * Output only. A field that if true, indicates that the system is working to compile and deploy the connector. + */ + reconciling?: boolean | null; + /** + * Required. The source files that comprise the connector. + */ + source?: Schema$Source; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. [Output only] Update time stamp. + */ + updateTime?: string | null; + } + /** + * A data source that backs Firebase Data Connect services. + */ + export interface Schema$Datasource { + /** + * PostgreSQL configurations. + */ + postgresql?: Schema$PostgreSql; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * The ExecuteMutation request to Firebase Data Connect. + */ + export interface Schema$ExecuteMutationRequest { + /** + * Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name. + */ + operationName?: string | null; + /** + * Optional. Values for GraphQL variables provided in this request. + */ + variables?: {[key: string]: any} | null; + } + /** + * The ExecuteMutation response from Firebase Data Connect. + */ + export interface Schema$ExecuteMutationResponse { + /** + * The result of executing the requested operation. + */ + data?: {[key: string]: any} | null; + /** + * Errors of this response. + */ + errors?: Schema$GraphqlError[]; + } + /** + * The ExecuteQuery request to Firebase Data Connect. + */ + export interface Schema$ExecuteQueryRequest { + /** + * Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name. + */ + operationName?: string | null; + /** + * Optional. Values for GraphQL variables provided in this request. + */ + variables?: {[key: string]: any} | null; + } + /** + * The ExecuteQuery response from Firebase Data Connect. + */ + export interface Schema$ExecuteQueryResponse { + /** + * The result of executing the requested operation. + */ + data?: {[key: string]: any} | null; + /** + * Errors of this response. + */ + errors?: Schema$GraphqlError[]; + } + /** + * Individual files. + */ + export interface Schema$File { + /** + * Required. The file's textual content. + */ + content?: string | null; + /** + * Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/x.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/x.gql). + */ + path?: string | null; + } + /** + * GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + */ + export interface Schema$GraphqlError { + /** + * Additional error information. + */ + extensions?: Schema$GraphqlErrorExtensions; + /** + * The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + */ + locations?: Schema$SourceLocation[]; + /** + * The detailed error message. The message should help developer understand the underlying problem without leaking internal data. + */ + message?: string | null; + /** + * The result field which could not be populated due to error. Clients can use path to identify whether a null result is intentional or caused by a runtime error. It should be a list of string or index from the root of GraphQL query document. + */ + path?: any[] | null; + } + /** + * GraphqlErrorExtensions contains additional information of `GraphqlError`. + */ + export interface Schema$GraphqlErrorExtensions { + /** + * The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. + */ + file?: string | null; + } + /** + * The GraphQL request to Firebase Data Connect. It strives to match the GraphQL over HTTP spec. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#post + */ + export interface Schema$GraphqlRequest { + /** + * Optional. Additional GraphQL request information. + */ + extensions?: Schema$GraphqlRequestExtensions; + /** + * Optional. The name of the GraphQL operation name. Required only if `query` contains multiple operations. See https://graphql.org/learn/queries/#operation-name. + */ + operationName?: string | null; + /** + * Required. The GraphQL query document source. + */ + query?: string | null; + /** + * Optional. Values for GraphQL variables provided in this request. + */ + variables?: {[key: string]: any} | null; + } + /** + * GraphqlRequestExtensions contains additional information of `GraphqlRequest`. + */ + export interface Schema$GraphqlRequestExtensions { + /** + * Optional. If set, impersonate a request with given Firebase Auth context and evaluate the auth policies on the operation. If omitted, bypass any defined auth policies. + */ + impersonate?: Schema$Impersonation; + } + /** + * The GraphQL response from Firebase Data Connect. It strives to match the GraphQL over HTTP spec. Note: Firebase Data Connect always responds with `Content-Type: application/json`. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#body + */ + export interface Schema$GraphqlResponse { + /** + * The result of the execution of the requested operation. If an error was raised before execution begins, the data entry should not be present in the result. (a request error: https://spec.graphql.org/draft/#sec-Errors.Request-Errors) If an error was raised during the execution that prevented a valid response, the data entry in the response should be null. (a field error: https://spec.graphql.org/draft/#sec-Errors.Error-Result-Format) + */ + data?: {[key: string]: any} | null; + /** + * Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. + */ + errors?: Schema$GraphqlError[]; + } + /** + * Impersonation configures the Firebase Auth context to impersonate. + */ + export interface Schema$Impersonation { + /** + * Evaluate the auth policy with a customized JWT auth token. Should follow the Firebase Auth token format. https://firebase.google.com/docs/rules/rules-and-auth For example: a verified user may have auth_claims of {"sub": , "email_verified": true\} + */ + authClaims?: {[key: string]: any} | null; + /** + * Evaluate the auth policy as an unauthenticated request. Can only be set to true. + */ + unauthenticated?: boolean | null; + } + /** + * Message for response to listing Connectors. By default, `connectors.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`. + */ + export interface Schema$ListConnectorsResponse { + /** + * The list of Connectors. + */ + connectors?: Schema$Connector[]; + /** + * 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; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * 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[]; + } + /** + * Message for response to listing Schemas. By default, `schemas.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`. + */ + export interface Schema$ListSchemasResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The list of Schemas. + */ + schemas?: Schema$Schema[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing Services. + */ + export interface Schema$ListServicesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The list of Services. + */ + services?: Schema$Service[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$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. Note: This message is auto-generated by CCFE. CCFE's storage, called Resource Metadata Store (RMS), holds metadata about long-running operations (i.e. OperationMetadata) and resources (i.e. ResourceMetadata). OperationMetadata documents the status of the operation. See [CCFE documentation for sidechannel data](https://g3doc.corp.google.com/cloud/control2/g3doc/dev/codelab_extras/sidechannel.md?cl=head#sidechannel-data) and yaqs/4289526912465764352. + */ + 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; + } + /** + * Settings for PostgreSQL data source. + */ + export interface Schema$PostgreSql { + /** + * Cloud SQL configurations. + */ + cloudSql?: Schema$CloudSqlInstance; + /** + * Required. Name of the PostgreSQL database. + */ + database?: string | null; + /** + * Optional. Configure how to perform Postgresql schema migration. + */ + schemaMigration?: string | null; + /** + * Optional. Configure how much Postgresql schema validation to perform. + */ + schemaValidation?: string | null; + /** + * No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. + */ + unlinked?: boolean | null; + } + /** + * The application schema of a Firebase Data Connect service. + */ + export interface Schema$Schema { + /** + * Optional. Stores small amounts of arbitrary data. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. [Output only] Create time stamp. + */ + createTime?: string | null; + /** + * Required. The data sources linked in the schema. + */ + datasources?: Schema$Datasource[]; + /** + * Optional. Mutable human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Output only. 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. [AIP-154](https://google.aip.dev/154) + */ + etag?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The relative resource name of the schema, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/schemas/{schema\} ``` Right now, the only supported schema is "main". + */ + name?: string | null; + /** + * Output only. A field that if true, indicates that the system is working to compile and deploy the schema. + */ + reconciling?: boolean | null; + /** + * Required. The source files that comprise the application schema. + */ + source?: Schema$Source; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. [Output only] Update time stamp. + */ + updateTime?: string | null; + } + /** + * A Firebase Data Connect service. + */ + export interface Schema$Service { + /** + * Optional. Stores small amounts of arbitrary data. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. [Output only] Create time stamp. + */ + createTime?: string | null; + /** + * Optional. Mutable human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Output only. 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. [AIP-154](https://google.aip.dev/154) + */ + etag?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The relative resource name of the Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` Note that the service ID is specific to Firebase Data Connect and does not correspond to any of the instance IDs of the underlying data source connections. + */ + name?: string | null; + /** + * Output only. A field that if true, indicates that the system is working update the service. + */ + reconciling?: boolean | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. [Output only] Update time stamp. + */ + updateTime?: string | null; + } + /** + * Used to represent a set of source files. + */ + export interface Schema$Source { + /** + * Required. The files that comprise the source set. + */ + files?: Schema$File[]; + } + /** + * SourceLocation references a location in a GraphQL source. + */ + export interface Schema$SourceLocation { + /** + * Column number starting at 1. + */ + column?: number | null; + /** + * Line number starting at 1. + */ + line?: 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). + */ + 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; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + services: Resource$Projects$Locations$Services; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.services = new Resource$Projects$Locations$Services(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://firebasedataconnect.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://firebasedataconnect.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 { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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://firebasedataconnect.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://firebasedataconnect.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://firebasedataconnect.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; + } + + export class Resource$Projects$Locations$Services { + context: APIRequestContext; + connectors: Resource$Projects$Locations$Services$Connectors; + schemas: Resource$Projects$Locations$Services$Schemas; + constructor(context: APIRequestContext) { + this.context = context; + this.connectors = new Resource$Projects$Locations$Services$Connectors( + this.context + ); + this.schemas = new Resource$Projects$Locations$Services$Schemas( + this.context + ); + } + + /** + * Creates a new Service 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$Services$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Services$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Services$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Services$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Services$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/services').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 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$Services$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Services$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Services$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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); + } + } + + /** + * Execute any GraphQL query and mutation against the Firebase Data Connect's generated GraphQL schema. Grants full read and write access to the connected data sources. Note: Use introspection query to explore the generated GraphQL schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executeGraphql( + params: Params$Resource$Projects$Locations$Services$Executegraphql, + options: StreamMethodOptions + ): GaxiosPromise; + executeGraphql( + params?: Params$Resource$Projects$Locations$Services$Executegraphql, + options?: MethodOptions + ): GaxiosPromise; + executeGraphql( + params: Params$Resource$Projects$Locations$Services$Executegraphql, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeGraphql( + params: Params$Resource$Projects$Locations$Services$Executegraphql, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeGraphql( + params: Params$Resource$Projects$Locations$Services$Executegraphql, + callback: BodyResponseCallback + ): void; + executeGraphql( + callback: BodyResponseCallback + ): void; + executeGraphql( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Executegraphql + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Executegraphql; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Executegraphql; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:executeGraphql').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); + } + } + + /** + * Execute any GraphQL query against the Firebase Data Connect's generated GraphQL schema. Grants full read to the connected data sources. `ExecuteGraphqlRead` is identical to `ExecuteGraphql` except it only accepts read-only query. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executeGraphqlRead( + params: Params$Resource$Projects$Locations$Services$Executegraphqlread, + options: StreamMethodOptions + ): GaxiosPromise; + executeGraphqlRead( + params?: Params$Resource$Projects$Locations$Services$Executegraphqlread, + options?: MethodOptions + ): GaxiosPromise; + executeGraphqlRead( + params: Params$Resource$Projects$Locations$Services$Executegraphqlread, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeGraphqlRead( + params: Params$Resource$Projects$Locations$Services$Executegraphqlread, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeGraphqlRead( + params: Params$Resource$Projects$Locations$Services$Executegraphqlread, + callback: BodyResponseCallback + ): void; + executeGraphqlRead( + callback: BodyResponseCallback + ): void; + executeGraphqlRead( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Executegraphqlread + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Executegraphqlread; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Executegraphqlread; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:executeGraphqlRead').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 details of a single 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$Services$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Services$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Services$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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 Services 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$Services$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Services$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Services$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/services').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 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$Services$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Services$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Services$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Services$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Services$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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$Services$Create + extends StandardParameters { + /** + * Required. Value of parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. The ID to use for the service, which will become the final component of the service's resource name. + */ + serviceId?: string; + /** + * Optional. If set, validate the request and preview the Service, but do not actually create it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + export interface Params$Resource$Projects$Locations$Services$Delete + extends StandardParameters { + /** + * Optional. If true and the Service is not found, the request will succeed but no action will be taken on the server. + */ + allowMissing?: boolean; + /** + * Optional. The etag of the Service. If this is provided, it must match the server's etag. + */ + etag?: string; + /** + * Optional. If set to true, any child resources (i.e. Schema, SchemaRevisions, Connectors, and ConnectorRevisions) will also be deleted. Otherwise, the request will only work if the Service has no child resources. + */ + force?: boolean; + /** + * Required. The name of the service to delete, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validate the request and preview the Service, but do not actually delete it. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Services$Executegraphql + extends StandardParameters { + /** + * Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GraphqlRequest; + } + export interface Params$Resource$Projects$Locations$Services$Executegraphqlread + extends StandardParameters { + /** + * Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GraphqlRequest; + } + export interface Params$Resource$Projects$Locations$Services$Get + extends StandardParameters { + /** + * Required. The name of the service to retrieve, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Services$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 page token, received from a previous `ListServices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListServices` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Value of parent. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Services$Patch + extends StandardParameters { + /** + * Optional. If true and the Service is not found, a new Service will be created. In this case, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Identifier. The relative resource name of the Firebase Data Connect service, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` Note that the service ID is specific to Firebase Data Connect and does not correspond to any of the instance IDs of the underlying data source connections. + */ + 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; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Service 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; + /** + * Optional. If set, validate the request and preview the Service, but do not actually update it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + + export class Resource$Projects$Locations$Services$Connectors { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Connector in a given project and location. The operations are validated against and must be compatible with the active schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Services$Connectors$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Services$Connectors$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Services$Connectors$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Services$Connectors$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Services$Connectors$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/connectors').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 Connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Services$Connectors$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Services$Connectors$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Services$Connectors$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Connectors$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Connectors$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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); + } + } + + /** + * Execute a predefined mutation in a Connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executeMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Executemutation, + options: StreamMethodOptions + ): GaxiosPromise; + executeMutation( + params?: Params$Resource$Projects$Locations$Services$Connectors$Executemutation, + options?: MethodOptions + ): GaxiosPromise; + executeMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Executemutation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Executemutation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeMutation( + params: Params$Resource$Projects$Locations$Services$Connectors$Executemutation, + callback: BodyResponseCallback + ): void; + executeMutation( + callback: BodyResponseCallback + ): void; + executeMutation( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Executemutation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Executemutation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Executemutation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:executeMutation').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); + } + } + + /** + * Execute a predefined query in a Connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executeQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Executequery, + options: StreamMethodOptions + ): GaxiosPromise; + executeQuery( + params?: Params$Resource$Projects$Locations$Services$Connectors$Executequery, + options?: MethodOptions + ): GaxiosPromise; + executeQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Executequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Executequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeQuery( + params: Params$Resource$Projects$Locations$Services$Connectors$Executequery, + callback: BodyResponseCallback + ): void; + executeQuery( + callback: BodyResponseCallback + ): void; + executeQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Executequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Executequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Executequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:executeQuery').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 details of a single Connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Services$Connectors$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Services$Connectors$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Services$Connectors$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Connectors$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Connectors$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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 Connectors 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$Services$Connectors$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Services$Connectors$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Services$Connectors$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$Connectors$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$Connectors$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/connectors').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 Connector, and creates a new ConnectorRevision with the updated Connector. The operations are validated against and must be compatible with the live schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Services$Connectors$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Services$Connectors$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Services$Connectors$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Services$Connectors$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Services$Connectors$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Connectors$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Connectors$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Connectors$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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$Services$Connectors$Create + extends StandardParameters { + /** + * Required. The ID to use for the connector, which will become the final component of the connector's resource name. + */ + connectorId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validate the request and preview the Connector, but do not actually create it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Connector; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$Delete + extends StandardParameters { + /** + * Optional. If true and the Connector is not found, the request will succeed but no action will be taken on the server. + */ + allowMissing?: boolean; + /** + * Optional. The etag of the Connector. If this is provided, it must match the server's etag. + */ + etag?: string; + /** + * Optional. If set to true, any child resources (i.e. ConnectorRevisions) will also be deleted. Otherwise, the request will only work if the Connector has no child resources. + */ + force?: boolean; + /** + * Required. The name of the connector to delete, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validate the request and preview the Connector, but do not actually delete it. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$Executemutation + extends StandardParameters { + /** + * Required. The resource name of the connector to find the predefined mutation, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExecuteMutationRequest; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$Executequery + extends StandardParameters { + /** + * Required. The resource name of the connector to find the predefined query, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExecuteQueryRequest; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$Get + extends StandardParameters { + /** + * Required. The name of the connector to retrieve, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$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 page token, received from a previous `ListConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectors` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Value of parent. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Services$Connectors$Patch + extends StandardParameters { + /** + * Optional. If true and the Connector is not found, a new Connector will be created. In this case, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Identifier. The relative resource name of the connector, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/connectors/{connector\} ``` + */ + 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; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Connector 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; + /** + * Optional. If set, validate the request and preview the Connector, but do not actually update it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Connector; + } + + export class Resource$Projects$Locations$Services$Schemas { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Schema in a given project and location. Only creation of `schemas/main` is supported and calling create with any other schema ID will result in an error. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Services$Schemas$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Services$Schemas$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Services$Schemas$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Services$Schemas$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Services$Schemas$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Schemas$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Schemas$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Schemas$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Schema. Because the schema and connectors must be compatible at all times, if this is called while any connectors are active, this will result in an error. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Services$Schemas$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Services$Schemas$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Services$Schemas$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Schemas$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Schemas$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Schemas$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Schemas$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Schemas$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Services$Schemas$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Services$Schemas$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Services$Schemas$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Schemas$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Schemas$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Schemas$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Schemas$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Schemas$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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 Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Services$Schemas$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Services$Schemas$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Services$Schemas$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$Schemas$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$Schemas$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Schemas$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Schemas$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Schemas$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/schemas').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 Schema, and creates a new SchemaRevision with the updated Schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Services$Schemas$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Services$Schemas$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Services$Schemas$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Services$Schemas$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Services$Schemas$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Schemas$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Schemas$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Schemas$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.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$Services$Schemas$Create + extends StandardParameters { + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. The ID to use for the schema, which will become the final component of the schema's resource name. Currently, only `main` is supported and any other schema ID will result in an error. + */ + schemaId?: string; + /** + * Optional. If set, validate the request and preview the Schema, but do not actually update it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Schema; + } + export interface Params$Resource$Projects$Locations$Services$Schemas$Delete + extends StandardParameters { + /** + * Optional. If true and the Schema is not found, the request will succeed but no action will be taken on the server. + */ + allowMissing?: boolean; + /** + * Optional. The etag of the Schema. If this is provided, it must match the server's etag. + */ + etag?: string; + /** + * Optional. If set to true, any child resources (i.e. SchemaRevisions) will also be deleted. + */ + force?: boolean; + /** + * Required. The name of the schema to delete, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/schemas/{schema\} ``` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validate the request and preview the Schema, but do not actually delete it. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Services$Schemas$Get + extends StandardParameters { + /** + * Required. The name of the schema to retrieve, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/schemas/{schema\} ``` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Services$Schemas$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 page token, received from a previous `ListSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSchemas` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Value of parent. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Services$Schemas$Patch + extends StandardParameters { + /** + * Optional. If true and the Schema is not found, a new Schema will be created. In this case, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Identifier. The relative resource name of the schema, in the format: ``` projects/{project\}/locations/{location\}/services/{service\}/schemas/{schema\} ``` Right now, the only supported schema is "main". + */ + 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; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Schema 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; + /** + * Optional. If set, validate the request and preview the Schema, but do not actually update it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Schema; + } +} diff --git a/src/apis/firebasedataconnect/v1beta.ts b/src/apis/firebasedataconnect/v1beta.ts index c3af3df7d12..fc6e9367f23 100644 --- a/src/apis/firebasedataconnect/v1beta.ts +++ b/src/apis/firebasedataconnect/v1beta.ts @@ -872,6 +872,10 @@ export namespace firebasedataconnect_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index a6f23039bed..8f6f5484bfb 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -361,7 +361,7 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1FunctionCall { /** - * Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + * Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. */ args?: {[key: string]: any} | null; /** @@ -551,6 +551,10 @@ export namespace firebaseml_v2beta { * Total token count for prompt, response candidates, and tool-use prompts (if present). */ totalTokenCount?: number | null; + /** + * Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + */ + trafficType?: string | null; } /** * Generation config. @@ -580,6 +584,10 @@ export namespace firebaseml_v2beta { * Optional. If specified, the media resolution specified will be used. */ mediaResolution?: string | null; + /** + * Optional. Config for model selection. + */ + modelConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigModelConfig; /** * Optional. Positive penalties. */ @@ -620,6 +628,10 @@ 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. */ @@ -629,6 +641,15 @@ export namespace firebaseml_v2beta { */ topP?: number | null; } + /** + * Config for model selection. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigModelConfig { + /** + * Required. Feature selection preference. + */ + featureSelectionPreference?: string | null; + } /** * The configuration for routing the request to a specific model. */ @@ -656,10 +677,19 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode { /** - * The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'. + * The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */ modelName?: string | null; } + /** + * Config for thinking features. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig { + /** + * Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. + */ + thinkingBudget?: number | null; + } /** * Tool to retrieve public web data for grounding, powered by Google. */ @@ -686,6 +716,10 @@ export namespace firebaseml_v2beta { * Chunk from context retrieved by the retrieval tools. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext { + /** + * Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + */ + ragChunk?: Schema$GoogleCloudAiplatformV1beta1RagChunk; /** * Text of the attribution. */ @@ -864,6 +898,32 @@ export namespace firebaseml_v2beta { */ voiceName?: string | null; } + /** + * A RagChunk includes the content of a chunk of a RagFile, and associated metadata. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagChunk { + /** + * If populated, represents where the chunk starts and ends in the document. + */ + pageSpan?: Schema$GoogleCloudAiplatformV1beta1RagChunkPageSpan; + /** + * The content of the chunk. + */ + text?: string | null; + } + /** + * Represents where the chunk starts and ends in the document. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagChunkPageSpan { + /** + * Page where chunk starts in the document. Inclusive. 1-indexed. + */ + firstPage?: number | null; + /** + * Page where chunk ends in the document. Inclusive. 1-indexed. + */ + lastPage?: number | null; + } /** * Specifies the context retrieval config. */ @@ -929,7 +989,7 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker { /** - * Optional. The model name used for ranking. Format: `gemini-1.5-pro` + * Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */ modelName?: string | null; } @@ -1031,6 +1091,10 @@ export namespace firebaseml_v2beta { * Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. */ export interface Schema$GoogleCloudAiplatformV1beta1Schema { + /** + * Optional. Can either be a boolean or an object; controls the presence of additional properties. + */ + additionalProperties?: any | null; /** * Optional. The value should be validated against any (one or more) of the subschemas in the list. */ @@ -1039,6 +1103,10 @@ export namespace firebaseml_v2beta { * Optional. Default value of the data. */ default?: any | null; + /** + * Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + */ + defs?: {[key: string]: Schema$GoogleCloudAiplatformV1beta1Schema} | null; /** * Optional. The description of the data. */ @@ -1109,6 +1177,10 @@ export namespace firebaseml_v2beta { * Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. */ propertyOrdering?: string[] | null; + /** + * Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + */ + ref?: string | null; /** * Optional. Required properties of Type.OBJECT. */ @@ -1160,6 +1232,10 @@ export namespace firebaseml_v2beta { * The speech generation config. */ export interface Schema$GoogleCloudAiplatformV1beta1SpeechConfig { + /** + * Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + */ + languageCode?: string | null; /** * The configuration for the speaker to use. */ @@ -1227,6 +1303,14 @@ export namespace firebaseml_v2beta { * Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ engine?: string | null; + /** + * Optional. Filter strings to be passed to the search API. + */ + filter?: string | null; + /** + * Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + */ + maxResults?: number | null; } /** * Retrieve from Vertex RAG Store for grounding. diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 7343e1d32fa..b716ee24c63 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -805,6 +805,10 @@ export namespace firestore_v1 { * Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time. */ createTime?: string | null; + /** + * Immutable. The edition of the database. + */ + databaseEdition?: string | null; /** * State of delete protection for the database. */ @@ -821,6 +825,10 @@ export namespace firestore_v1 { * 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. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. + */ + freeTier?: boolean | null; /** * Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). */ @@ -845,6 +853,10 @@ export namespace firestore_v1 { * Output only. Information about the provenance of this database. */ sourceInfo?: Schema$GoogleFirestoreAdminV1SourceInfo; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + */ + tags?: {[key: string]: string} | null; /** * The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. */ @@ -866,6 +878,14 @@ export namespace firestore_v1 { * Metadata related to the delete database operation. */ export interface Schema$GoogleFirestoreAdminV1DeleteDatabaseMetadata {} + /** + * The request for FirestoreAdmin.DisableUserCreds. + */ + export interface Schema$GoogleFirestoreAdminV1DisableUserCredsRequest {} + /** + * The request for FirestoreAdmin.EnableUserCreds. + */ + export interface Schema$GoogleFirestoreAdminV1EnableUserCredsRequest {} /** * Encryption configuration for a new database being created from another source. The source could be a Backup . */ @@ -1078,10 +1098,18 @@ 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 MONGODB_COMPATIBLE_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. */ @@ -1090,6 +1118,10 @@ export namespace firestore_v1 { * Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. */ queryScope?: string | null; + /** + * Optional. The number of shards for the index. + */ + shardCount?: number | null; /** * Output only. The serving state of the index. */ @@ -1240,6 +1272,15 @@ export namespace firestore_v1 { */ nextPageToken?: string | null; } + /** + * The response for FirestoreAdmin.ListUserCreds. + */ + export interface Schema$GoogleFirestoreAdminV1ListUserCredsResponse { + /** + * The user creds for the database. + */ + userCreds?: Schema$GoogleFirestoreAdminV1UserCreds[]; + } /** * The metadata message for google.cloud.location.Location.metadata. */ @@ -1257,6 +1298,19 @@ export namespace firestore_v1 { */ estimatedWork?: string | null; } + /** + * The request for FirestoreAdmin.ResetUserPassword. + */ + export interface Schema$GoogleFirestoreAdminV1ResetUserPasswordRequest {} + /** + * Describes a Resource Identity principal. + */ + export interface Schema$GoogleFirestoreAdminV1ResourceIdentity { + /** + * Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers + */ + principal?: string | null; + } /** * Metadata for the long-running operation from the RestoreDatabase request. */ @@ -1302,6 +1356,10 @@ export namespace firestore_v1 { * Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption. */ encryptionConfig?: Schema$GoogleFirestoreAdminV1EncryptionConfig; + /** + * Optional. Immutable. Tags to be bound to the restored database. The tags should be provided in the format of `tagKeys/{tag_key_id\} -\> tagValues/{tag_value_id\}`. + */ + tags?: {[key: string]: string} | null; } /** * The configuration options for using the same encryption method as the source. @@ -1359,6 +1417,35 @@ export namespace firestore_v1 { * Metadata related to the update database operation. */ export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata {} + /** + * A Cloud Firestore User Creds. + */ + export interface Schema$GoogleFirestoreAdminV1UserCreds { + /** + * Output only. The time the user creds were created. + */ + createTime?: string | null; + /** + * Identifier. The resource name of the UserCreds. Format: `projects/{project\}/databases/{database\}/userCreds/{user_creds\}` + */ + name?: string | null; + /** + * Resource Identity descriptor. + */ + resourceIdentity?: Schema$GoogleFirestoreAdminV1ResourceIdentity; + /** + * Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword. + */ + securePassword?: string | null; + /** + * Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation. + */ + state?: string | null; + /** + * Output only. The time the user creds were last updated. + */ + updateTime?: string | null; + } /** * The index configuration to support vector search operations */ @@ -2105,6 +2192,7 @@ export namespace firestore_v1 { collectionGroups: Resource$Projects$Databases$Collectiongroups; documents: Resource$Projects$Databases$Documents; operations: Resource$Projects$Databases$Operations; + userCreds: Resource$Projects$Databases$Usercreds; constructor(context: APIRequestContext) { this.context = context; this.backupSchedules = new Resource$Projects$Databases$Backupschedules( @@ -2117,6 +2205,7 @@ export namespace firestore_v1 { this.operations = new Resource$Projects$Databases$Operations( this.context ); + this.userCreds = new Resource$Projects$Databases$Usercreds(this.context); } /** @@ -6639,66 +6728,161 @@ export namespace firestore_v1 { pageToken?: string; } - export class Resource$Projects$Locations { + export class Resource$Projects$Databases$Usercreds { context: APIRequestContext; - backups: Resource$Projects$Locations$Backups; constructor(context: APIRequestContext) { this.context = context; - this.backups = new Resource$Projects$Locations$Backups(this.context); } /** - * Gets information about a location. + * Create a user creds. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + create( + params: Params$Resource$Projects$Databases$Usercreds$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Get, + create( + params?: Params$Resource$Projects$Databases$Usercreds$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Databases$Usercreds$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Databases$Usercreds$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Databases$Usercreds$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Databases$Usercreds$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Projects$Databases$Usercreds$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = {} as Params$Resource$Projects$Databases$Usercreds$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/userCreds').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 user creds. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Databases$Usercreds$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Databases$Usercreds$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Databases$Usercreds$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Databases$Usercreds$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Databases$Usercreds$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Usercreds$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Usercreds$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Usercreds$Delete; options = {}; } @@ -6712,7 +6896,7 @@ export namespace firestore_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -6723,72 +6907,74 @@ export namespace firestore_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. + * Disables a user creds. No-op if the user creds are already disabled. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + disable( + params: Params$Resource$Projects$Databases$Usercreds$Disable, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$List, + disable( + params?: Params$Resource$Projects$Databases$Usercreds$Disable, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, + ): GaxiosPromise; + disable( + params: Params$Resource$Projects$Databases$Usercreds$Disable, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, + disable( + params: Params$Resource$Projects$Databases$Usercreds$Disable, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + disable( + params: Params$Resource$Projects$Databases$Usercreds$Disable, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + disable( + callback: BodyResponseCallback + ): void; + disable( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Databases$Usercreds$Disable + | 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$Databases$Usercreds$Disable; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Projects$Databases$Usercreds$Disable; options = {}; } @@ -6801,11 +6987,11 @@ export namespace firestore_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+name}:disable').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -6816,25 +7002,675 @@ export namespace firestore_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { /** - * Resource name for the location. + * Enables a user creds. No-op if the user creds are already 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. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { + enable( + params: Params$Resource$Projects$Databases$Usercreds$Enable, + options: StreamMethodOptions + ): GaxiosPromise; + enable( + params?: Params$Resource$Projects$Databases$Usercreds$Enable, + options?: MethodOptions + ): GaxiosPromise; + enable( + params: Params$Resource$Projects$Databases$Usercreds$Enable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Databases$Usercreds$Enable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Databases$Usercreds$Enable, + callback: BodyResponseCallback + ): void; + enable( + callback: BodyResponseCallback + ): void; + enable( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Usercreds$Enable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Usercreds$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Usercreds$Enable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:enable').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a user creds resource. Note that the returned resource does not contain the secret value itself. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Databases$Usercreds$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Databases$Usercreds$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Databases$Usercreds$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Databases$Usercreds$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Databases$Usercreds$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Usercreds$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Usercreds$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Usercreds$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List all user creds in the database. Note that the returned resource does not contain the secret value itself. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Databases$Usercreds$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Databases$Usercreds$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Databases$Usercreds$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Databases$Usercreds$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Databases$Usercreds$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Usercreds$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Usercreds$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Usercreds$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/userCreds').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 + ); + } + } + + /** + * Resets the password of a user creds. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resetPassword( + params: Params$Resource$Projects$Databases$Usercreds$Resetpassword, + options: StreamMethodOptions + ): GaxiosPromise; + resetPassword( + params?: Params$Resource$Projects$Databases$Usercreds$Resetpassword, + options?: MethodOptions + ): GaxiosPromise; + resetPassword( + params: Params$Resource$Projects$Databases$Usercreds$Resetpassword, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetPassword( + params: Params$Resource$Projects$Databases$Usercreds$Resetpassword, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetPassword( + params: Params$Resource$Projects$Databases$Usercreds$Resetpassword, + callback: BodyResponseCallback + ): void; + resetPassword( + callback: BodyResponseCallback + ): void; + resetPassword( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Usercreds$Resetpassword + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Usercreds$Resetpassword; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Databases$Usercreds$Resetpassword; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:resetPassword').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$Databases$Usercreds$Create + extends StandardParameters { + /** + * Required. A parent name of the form `projects/{project_id\}/databases/{database_id\}` + */ + parent?: string; + /** + * Required. The ID to use for the user creds, which will become the final component of the user creds's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. + */ + userCredsId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1UserCreds; + } + export interface Params$Resource$Projects$Databases$Usercreds$Delete + extends StandardParameters { + /** + * Required. A name of the form `projects/{project_id\}/databases/{database_id\}/userCreds/{user_creds_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Usercreds$Disable + extends StandardParameters { + /** + * Required. A name of the form `projects/{project_id\}/databases/{database_id\}/userCreds/{user_creds_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1DisableUserCredsRequest; + } + export interface Params$Resource$Projects$Databases$Usercreds$Enable + extends StandardParameters { + /** + * Required. A name of the form `projects/{project_id\}/databases/{database_id\}/userCreds/{user_creds_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1EnableUserCredsRequest; + } + export interface Params$Resource$Projects$Databases$Usercreds$Get + extends StandardParameters { + /** + * Required. A name of the form `projects/{project_id\}/databases/{database_id\}/userCreds/{user_creds_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Usercreds$List + extends StandardParameters { + /** + * Required. A parent database name of the form `projects/{project_id\}/databases/{database_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Databases$Usercreds$Resetpassword + extends StandardParameters { + /** + * Required. A name of the form `projects/{project_id\}/databases/{database_id\}/userCreds/{user_creds_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1ResetUserPasswordRequest; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + backups: Resource$Projects$Locations$Backups; + constructor(context: APIRequestContext) { + this.context = context; + this.backups = new Resource$Projects$Locations$Backups(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://firestore.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://firestore.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 { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/forms/v1.ts b/src/apis/forms/v1.ts index 1e6e7e3c378..f8d2fa009d2 100644 --- a/src/apis/forms/v1.ts +++ b/src/apis/forms/v1.ts @@ -382,19 +382,19 @@ export namespace forms_v1 { */ 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. + * 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 SetPublishSettings 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. + * 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. For forms that have publish_settings value set, this is the published form URI. */ responderUri?: string | null; /** - * Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes. + * Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published) */ revisionId?: string | null; /** - * The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest. + * The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during CreateForm and UpdateFormInfoRequest. */ settings?: Schema$FormSettings; } @@ -538,7 +538,7 @@ export namespace forms_v1 { */ description?: string | null; /** - * Output only. The title of the document which is visible in Drive. If `Info.title` is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`. + * Output only. The title of the document which is visible in Drive. If Info.title is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`. */ documentTitle?: string | null; /** @@ -882,11 +882,11 @@ export namespace forms_v1 { updateMask?: string | null; } /** - * The response of a `SetPublishSettings` request. + * 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. + * Required. The ID of the Form. This is same as the Form.form_id field. */ formId?: string | null; /** @@ -1486,7 +1486,7 @@ export namespace forms_v1 { export interface Params$Resource$Forms$Setpublishsettings extends StandardParameters { /** - * Required. The ID of the form. You can get the id from `Form.form_id` field. + * Required. The ID of the form. You can get the id from Form.form_id field. */ formId?: string; diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index a2d9c8443aa..2286a8d3ba2 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -100,7 +100,7 @@ export namespace games_v1 { } /** - * Google Play Game Services + * Google Play Games Services API * * The Google Play Games Service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more. * diff --git a/src/apis/gamesConfiguration/v1configuration.ts b/src/apis/gamesConfiguration/v1configuration.ts index 72974b43ce5..036bd531a1e 100644 --- a/src/apis/gamesConfiguration/v1configuration.ts +++ b/src/apis/gamesConfiguration/v1configuration.ts @@ -100,7 +100,7 @@ export namespace gamesConfiguration_v1configuration { } /** - * Google Play Game Services Publishing API + * Google Play Games Services Publishing API * * The Google Play Game Services Publishing API allows developers to configure their games in Game Services. * diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index 4cd0d2c172f..e63831fcf2c 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -100,7 +100,7 @@ export namespace gamesManagement_v1management { } /** - * Google Play Game Management + * Google Play Games Services Management API * * The Google Play Games Management API allows developers to manage resources from the Google Play Game service. * diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index 6494c9da6fc..a104e9db533 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -275,6 +275,47 @@ export namespace gkebackup_v1 { */ volumeCount?: number | null; } + /** + * A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project. + */ + export interface Schema$BackupChannel { + /** + * Output only. The timestamp when this BackupChannel resource was created. + */ + createTime?: string | null; + /** + * Optional. User specified descriptive string for this BackupChannel. + */ + description?: string | null; + /** + * Required. Immutable. The project where Backups are allowed to be stored. The format is `projects/{project\}`. Currently, {project\} can only be the project number. Support for project IDs will be added in the future. + */ + destinationProject?: string | null; + /** + * Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project. + */ + destinationProjectId?: string | null; + /** + * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupChannel`, and systems are expected to put that etag in the request to `UpdateBackupChannel` or `DeleteBackupChannel` to ensure that their change will be applied to the same version of the resource. + */ + etag?: string | null; + /** + * Optional. A set of custom labels supplied by user. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The fully qualified name of the BackupChannel. `projects/x/locations/x/backupChannels/x` + */ + name?: string | null; + /** + * Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. + */ + uid?: string | null; + /** + * Output only. The timestamp when this BackupChannel resource was last updated. + */ + updateTime?: string | null; + } /** * BackupConfig defines the configuration of Backups created via this BackupPlan. */ @@ -385,6 +426,72 @@ export namespace gkebackup_v1 { */ updateTime?: string | null; } + /** + * A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project. + */ + export interface Schema$BackupPlanBinding { + /** + * Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/x/locations/x/backupPlans/{backup_plan\}` + */ + backupPlan?: string | null; + /** + * Output only. Contains details about the backup plan/backup. + */ + backupPlanDetails?: Schema$BackupPlanDetails; + /** + * Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - `projects/x/locations/x/clusters/x` - `projects/x/zones/x/clusters/x` + */ + cluster?: string | null; + /** + * Output only. The timestamp when this binding was created. + */ + createTime?: string | null; + /** + * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlanBinding`, and systems are expected to put that etag in the request to `UpdateBackupPlanBinding` or `DeleteBackupPlanBinding` to ensure that their change will be applied to the same version of the resource. + */ + etag?: string | null; + /** + * Identifier. The fully qualified name of the BackupPlanBinding. `projects/x/locations/x/backupChannels/x/backupPlanBindings/x` + */ + name?: string | null; + /** + * Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) + */ + uid?: string | null; + /** + * Output only. The timestamp when this binding was created. + */ + updateTime?: string | null; + } + /** + * Contains metadata about the backup plan/backup. + */ + export interface Schema$BackupPlanDetails { + /** + * Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/x/locations/x/backupPlans/x/backups/x` + */ + lastSuccessfulBackup?: string | null; + /** + * Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. + */ + lastSuccessfulBackupTime?: string | null; + /** + * Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan. + */ + nextScheduledBackupTime?: string | null; + /** + * Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. + */ + protectedPodCount?: number | null; + /** + * Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk. + */ + rpoRiskLevel?: number | null; + /** + * Output only. State of the BackupPlan. + */ + state?: string | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -550,6 +657,9 @@ export namespace gkebackup_v1 { * Response message for GetBackupIndexDownloadUrl. */ export interface Schema$GetBackupIndexDownloadUrlResponse { + /** + * Required. The signed URL for downloading the backup index. + */ signedUrl?: string | null; } /** @@ -637,6 +747,40 @@ export namespace gkebackup_v1 { */ satisfying?: Schema$GroupKind; } + /** + * Response message for ListBackupChannels. + */ + export interface Schema$ListBackupChannelsResponse { + /** + * The list of BackupChannels matching the given criteria. + */ + backupChannels?: Schema$BackupChannel[]; + /** + * A token which may be sent as page_token in a subsequent `ListBackupChannels` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for ListBackupPlanBindings. + */ + export interface Schema$ListBackupPlanBindingsResponse { + /** + * The list of BackupPlanBindings matching the given criteria. + */ + backupPlanBindings?: Schema$BackupPlanBinding[]; + /** + * A token which may be sent as page_token in a subsequent `ListBackupPlanBindingss` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response message for ListBackupPlans. */ @@ -684,6 +828,40 @@ export namespace gkebackup_v1 { */ nextPageToken?: string | null; } + /** + * Response message for ListRestoreChannels. + */ + export interface Schema$ListRestoreChannelsResponse { + /** + * A token which may be sent as page_token in a subsequent `ListRestoreChannels` 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; + /** + * The list of RestoreChannels matching the given criteria. + */ + restoreChannels?: Schema$RestoreChannel[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for ListRestorePlanBindings. + */ + export interface Schema$ListRestorePlanBindingsResponse { + /** + * A token which may be sent as page_token in a subsequent `ListRestorePlanBindings` 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; + /** + * The list of RestorePlanBindings matching the given criteria. + */ + restorePlanBindings?: Schema$RestorePlanBinding[]; + /** + * Unordered list. Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response message for ListRestorePlans. */ @@ -913,7 +1091,7 @@ export namespace gkebackup_v1 { */ createTime?: string | null; /** - * User specified descriptive string for this Restore. + * Optional. User specified descriptive string for this Restore. */ description?: string | null; /** @@ -973,6 +1151,47 @@ export namespace gkebackup_v1 { */ volumesRestoredCount?: number | null; } + /** + * A RestoreChannel imposes constraints on where backups can be restored. The RestoreChannel should be in the same project and region as the backups. The backups can only be restored in the `destination_project`. + */ + export interface Schema$RestoreChannel { + /** + * Output only. The timestamp when this RestoreChannel was created. + */ + createTime?: string | null; + /** + * Optional. User specified descriptive string for this RestoreChannel. + */ + description?: string | null; + /** + * Required. Immutable. The project into which the backups will be restored. The format is `projects/{project\}`. Currently, {project\} can only be the project number. Support for project IDs will be added in the future. + */ + destinationProject?: string | null; + /** + * Output only. The project_id where backups will be restored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project. + */ + destinationProjectId?: string | null; + /** + * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestoreChannel`, and systems are expected to put that etag in the request to `UpdateRestoreChannel` or `DeleteRestoreChannel` to ensure that their change will be applied to the same version of the resource. + */ + etag?: string | null; + /** + * Optional. A set of custom labels supplied by user. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The fully qualified name of the RestoreChannel. `projects/x/locations/x/restoreChannels/x` + */ + name?: string | null; + /** + * Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. + */ + uid?: string | null; + /** + * Output only. The timestamp when this RestoreChannel was last updated. + */ + updateTime?: string | null; + } /** * Configuration of a restore. */ @@ -1092,6 +1311,39 @@ export namespace gkebackup_v1 { */ updateTime?: string | null; } + /** + * A RestorePlanBinding binds a RestorePlan with a RestoreChannel. This resource is created automatically when a RestorePlan is created using a RestoreChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project. + */ + export interface Schema$RestorePlanBinding { + /** + * Output only. The fully qualified name of the BackupPlan bound to the specified RestorePlan. `projects/x/locations/x/backukpPlans/{backup_plan\}` + */ + backupPlan?: string | null; + /** + * Output only. The timestamp when this binding was created. + */ + createTime?: string | null; + /** + * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestorePlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestorePlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlanBinding`, and systems are expected to put that etag in the request to `UpdateRestorePlanBinding` or `DeleteRestorePlanBinding` to ensure that their change will be applied to the same version of the resource. + */ + etag?: string | null; + /** + * Identifier. The fully qualified name of the RestorePlanBinding. `projects/x/locations/x/restoreChannels/x/restorePlanBindings/x` + */ + name?: string | null; + /** + * Output only. The fully qualified name of the RestorePlan bound to this RestoreChannel. `projects/x/locations/x/restorePlans/{restore_plan\}` + */ + restorePlan?: string | null; + /** + * Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) + */ + uid?: string | null; + /** + * Output only. The timestamp when this binding was created. + */ + updateTime?: string | null; + } /** * RetentionPolicy defines a Backup retention policy for a BackupPlan. */ @@ -1414,17 +1666,25 @@ export namespace gkebackup_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + backupChannels: Resource$Projects$Locations$Backupchannels; backupPlans: Resource$Projects$Locations$Backupplans; operations: Resource$Projects$Locations$Operations; + restoreChannels: Resource$Projects$Locations$Restorechannels; restorePlans: Resource$Projects$Locations$Restoreplans; constructor(context: APIRequestContext) { this.context = context; + this.backupChannels = new Resource$Projects$Locations$Backupchannels( + this.context + ); this.backupPlans = new Resource$Projects$Locations$Backupplans( this.context ); this.operations = new Resource$Projects$Locations$Operations( this.context ); + this.restoreChannels = new Resource$Projects$Locations$Restorechannels( + this.context + ); this.restorePlans = new Resource$Projects$Locations$Restoreplans( this.context ); @@ -1618,6 +1878,10 @@ export namespace gkebackup_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -1636,18 +1900,19 @@ export namespace gkebackup_v1 { pageToken?: string; } - export class Resource$Projects$Locations$Backupplans { + export class Resource$Projects$Locations$Backupchannels { context: APIRequestContext; - backups: Resource$Projects$Locations$Backupplans$Backups; + backupPlanBindings: Resource$Projects$Locations$Backupchannels$Backupplanbindings; constructor(context: APIRequestContext) { this.context = context; - this.backups = new Resource$Projects$Locations$Backupplans$Backups( - this.context - ); + this.backupPlanBindings = + new Resource$Projects$Locations$Backupchannels$Backupplanbindings( + this.context + ); } /** - * Creates a new BackupPlan in a given location. + * Creates a new BackupChannel in a given location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1655,27 +1920,27 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Backupplans$Create, + params: Params$Resource$Projects$Locations$Backupchannels$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Backupplans$Create, + params?: Params$Resource$Projects$Locations$Backupchannels$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Backupplans$Create, + params: Params$Resource$Projects$Locations$Backupchannels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Backupplans$Create, + params: Params$Resource$Projects$Locations$Backupchannels$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Backupplans$Create, + params: Params$Resource$Projects$Locations$Backupchannels$Create, callback: BodyResponseCallback ): void; create( @@ -1683,7 +1948,7 @@ export namespace gkebackup_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Create + | Params$Resource$Projects$Locations$Backupchannels$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -1699,12 +1964,12 @@ export namespace gkebackup_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Create; + {}) as Params$Resource$Projects$Locations$Backupchannels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Backupplans$Create; + params = {} as Params$Resource$Projects$Locations$Backupchannels$Create; options = {}; } @@ -1717,7 +1982,7 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/backupPlans').replace( + url: (rootUrl + '/v1/{+parent}/backupChannels').replace( /([^:]\/)\/+/g, '$1' ), @@ -1742,7 +2007,7 @@ export namespace gkebackup_v1 { } /** - * Deletes an existing BackupPlan. + * Deletes an existing BackupChannel. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1750,27 +2015,27 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Backupplans$Delete, + params: Params$Resource$Projects$Locations$Backupchannels$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Backupplans$Delete, + params?: Params$Resource$Projects$Locations$Backupchannels$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Backupplans$Delete, + params: Params$Resource$Projects$Locations$Backupchannels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Backupplans$Delete, + params: Params$Resource$Projects$Locations$Backupchannels$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Backupplans$Delete, + params: Params$Resource$Projects$Locations$Backupchannels$Delete, callback: BodyResponseCallback ): void; delete( @@ -1778,7 +2043,7 @@ export namespace gkebackup_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Delete + | Params$Resource$Projects$Locations$Backupchannels$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -1794,12 +2059,12 @@ export namespace gkebackup_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Delete; + {}) as Params$Resource$Projects$Locations$Backupchannels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Backupplans$Delete; + params = {} as Params$Resource$Projects$Locations$Backupchannels$Delete; options = {}; } @@ -1834,7 +2099,7 @@ export namespace gkebackup_v1 { } /** - * Retrieve the details of a single BackupPlan. + * Retrieve the details of a single BackupChannel. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1842,49 +2107,49 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Backupplans$Get, + params: Params$Resource$Projects$Locations$Backupchannels$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Backupplans$Get, + params?: Params$Resource$Projects$Locations$Backupchannels$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Backupplans$Get, + params: Params$Resource$Projects$Locations$Backupchannels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Backupplans$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupchannels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Backupplans$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupchannels$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupchannels$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$Backupplans$Get; + {}) as Params$Resource$Projects$Locations$Backupchannels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Backupplans$Get; + params = {} as Params$Resource$Projects$Locations$Backupchannels$Get; options = {}; } @@ -1909,161 +2174,74 @@ export namespace gkebackup_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists BackupChannels in a given 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$Backupplans$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Backupchannels$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Backupchannels$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupchannels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Backupchannels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Backupplans$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://gkebackup.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 BackupPlans in a given location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Backupplans$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Backupplans$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Backupplans$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Backupchannels$List, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Backupplans$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Backupplans$List, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupchannels$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$Backupplans$List; + {}) as Params$Resource$Projects$Locations$Backupchannels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Backupplans$List; + params = {} as Params$Resource$Projects$Locations$Backupchannels$List; options = {}; } @@ -2076,7 +2254,7 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/backupPlans').replace( + url: (rootUrl + '/v1/{+parent}/backupChannels').replace( /([^:]\/)\/+/g, '$1' ), @@ -2091,17 +2269,17 @@ export namespace gkebackup_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Update a BackupPlan. + * Update a BackupChannel. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2109,27 +2287,27 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Backupplans$Patch, + params: Params$Resource$Projects$Locations$Backupchannels$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Backupplans$Patch, + params?: Params$Resource$Projects$Locations$Backupchannels$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Backupplans$Patch, + params: Params$Resource$Projects$Locations$Backupchannels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Backupplans$Patch, + params: Params$Resource$Projects$Locations$Backupchannels$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Backupplans$Patch, + params: Params$Resource$Projects$Locations$Backupchannels$Patch, callback: BodyResponseCallback ): void; patch( @@ -2137,7 +2315,7 @@ export namespace gkebackup_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Patch + | Params$Resource$Projects$Locations$Backupchannels$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2153,12 +2331,12 @@ export namespace gkebackup_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Patch; + {}) as Params$Resource$Projects$Locations$Backupchannels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Backupplans$Patch; + params = {} as Params$Resource$Projects$Locations$Backupchannels$Patch; options = {}; } @@ -2191,60 +2369,148 @@ export namespace gkebackup_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Backupchannels$Create + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name. + */ + backupChannelId?: string; + /** + * Required. The location within which to create the BackupChannel. Format: `projects/x/locations/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupChannel; + } + export interface Params$Resource$Projects$Locations$Backupchannels$Delete + extends StandardParameters { + /** + * Optional. If provided, this value must match the current value of the target BackupChannel's etag field or the request is rejected. + */ + etag?: string; + /** + * Optional. If set to true, any BackupPlanAssociations below this BackupChannel will also be deleted. Otherwise, the request will only succeed if the BackupChannel has no BackupPlanAssociations. + */ + force?: boolean; + /** + * Required. Fully qualified BackupChannel name. Format: `projects/x/locations/x/backupChannels/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupchannels$Get + extends StandardParameters { + /** + * Required. Fully qualified BackupChannel name. Format: `projects/x/locations/x/backupChannels/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupchannels$List + extends StandardParameters { + /** + * Optional. Field match expression used to filter the results. + */ + filter?: string; + /** + * Optional. Field by which to sort the results. + */ + orderBy?: string; + /** + * Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The value of next_page_token received from a previous `ListBackupChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupChannels` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The location that contains the BackupChannels to list. Format: `projects/x/locations/x` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupchannels$Patch + extends StandardParameters { + /** + * Identifier. The fully qualified name of the BackupChannel. `projects/x/locations/x/backupChannels/x` + */ + name?: string; + /** + * Optional. This is used to specify the fields to be overwritten in the BackupChannel targeted for update. The values for each of these updated fields will be taken from the `backup_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `labels`, etc.) If no `update_mask` is provided, all fields in `backup_channel` will be written to the target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_channel` are ignored and are not used to update the target BackupChannel. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupChannel; + } + + export class Resource$Projects$Locations$Backupchannels$Backupplanbindings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieve the details of a single BackupPlanBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupplans$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$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$Backupplans$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Setiampolicy; + {} as Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get; options = {}; } @@ -2257,90 +2523,87 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists BackupPlanBindings in a given location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$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$Backupplans$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Testiampermissions; + {} as Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List; options = {}; } @@ -2353,77 +2616,41 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/backupPlanBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Backupplans$Create - extends StandardParameters { - /** - * Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location - */ - backupPlanId?: string; - /** - * Required. The location within which to create the BackupPlan. Format: `projects/x/locations/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BackupPlan; - } - export interface Params$Resource$Projects$Locations$Backupplans$Delete - extends StandardParameters { - /** - * Optional. If provided, this value must match the current value of the target BackupPlan's etag field or the request is rejected. - */ - etag?: string; - /** - * Required. Fully qualified BackupPlan name. Format: `projects/x/locations/x/backupPlans/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Backupplans$Get + export interface Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$Get extends StandardParameters { /** - * Required. Fully qualified BackupPlan name. Format: `projects/x/locations/x/backupPlans/x` + * Required. Fully qualified BackupPlanBinding name. Format: `projects/x/locations/x/backupChannels/x/backupPlanBindings/x` */ name?: string; } - export interface Params$Resource$Projects$Locations$Backupplans$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$Backupplans$List + export interface Params$Resource$Projects$Locations$Backupchannels$Backupplanbindings$List extends StandardParameters { /** * Optional. Field match expression used to filter the results. @@ -2438,68 +2665,27 @@ export namespace gkebackup_v1 { */ pageSize?: number; /** - * Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token. + * Optional. The value of next_page_token received from a previous `ListBackupPlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlanBindings` must match the call that provided the page token. */ pageToken?: string; /** - * Required. The location that contains the BackupPlans to list. Format: `projects/x/locations/x` + * Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects/x/locations/x/backupChannels/x` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Backupplans$Patch - extends StandardParameters { - /** - * Output only. The full name of the BackupPlan resource. Format: `projects/x/locations/x/backupPlans/x` - */ - name?: string; - /** - * Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` is provided, all fields in `backup_plan` will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used to update the target BackupPlan. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BackupPlan; - } - export interface Params$Resource$Projects$Locations$Backupplans$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$Backupplans$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$Backupplans$Backups { + export class Resource$Projects$Locations$Backupplans { context: APIRequestContext; - volumeBackups: Resource$Projects$Locations$Backupplans$Backups$Volumebackups; + backups: Resource$Projects$Locations$Backupplans$Backups; constructor(context: APIRequestContext) { this.context = context; - this.volumeBackups = - new Resource$Projects$Locations$Backupplans$Backups$Volumebackups( - this.context - ); + this.backups = new Resource$Projects$Locations$Backupplans$Backups( + this.context + ); } /** - * Creates a Backup for the given BackupPlan. + * Creates a new BackupPlan in a given location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2507,27 +2693,27 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, + params: Params$Resource$Projects$Locations$Backupplans$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Create, + params?: Params$Resource$Projects$Locations$Backupplans$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, + params: Params$Resource$Projects$Locations$Backupplans$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, + params: Params$Resource$Projects$Locations$Backupplans$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, + params: Params$Resource$Projects$Locations$Backupplans$Create, callback: BodyResponseCallback ): void; create( @@ -2535,7 +2721,7 @@ export namespace gkebackup_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Create + | Params$Resource$Projects$Locations$Backupplans$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2551,13 +2737,12 @@ export namespace gkebackup_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Create; + {}) as Params$Resource$Projects$Locations$Backupplans$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Create; + params = {} as Params$Resource$Projects$Locations$Backupplans$Create; options = {}; } @@ -2570,7 +2755,7 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/backups').replace( + url: (rootUrl + '/v1/{+parent}/backupPlans').replace( /([^:]\/)\/+/g, '$1' ), @@ -2595,7 +2780,7 @@ export namespace gkebackup_v1 { } /** - * Deletes an existing Backup. + * Deletes an existing BackupPlan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2603,27 +2788,27 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, + params: Params$Resource$Projects$Locations$Backupplans$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, + params?: Params$Resource$Projects$Locations$Backupplans$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, + params: Params$Resource$Projects$Locations$Backupplans$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, + params: Params$Resource$Projects$Locations$Backupplans$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, + params: Params$Resource$Projects$Locations$Backupplans$Delete, callback: BodyResponseCallback ): void; delete( @@ -2631,7 +2816,7 @@ export namespace gkebackup_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Delete + | Params$Resource$Projects$Locations$Backupplans$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2647,13 +2832,12 @@ export namespace gkebackup_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Delete; + {}) as Params$Resource$Projects$Locations$Backupplans$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Delete; + params = {} as Params$Resource$Projects$Locations$Backupplans$Delete; options = {}; } @@ -2688,7 +2872,7 @@ export namespace gkebackup_v1 { } /** - * Retrieve the details of a single Backup. + * Retrieve the details of a single BackupPlan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2696,50 +2880,49 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, + params: Params$Resource$Projects$Locations$Backupplans$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Get, + params?: Params$Resource$Projects$Locations$Backupplans$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, + params: Params$Resource$Projects$Locations$Backupplans$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupplans$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupplans$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupplans$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$Backupplans$Backups$Get; + {}) as Params$Resource$Projects$Locations$Backupplans$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Get; + params = {} as Params$Resource$Projects$Locations$Backupplans$Get; options = {}; } @@ -2764,75 +2947,68 @@ export namespace gkebackup_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieve the link to the backupIndex. + * 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. */ - getBackupIndexDownloadUrl( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - getBackupIndexDownloadUrl( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - getBackupIndexDownloadUrl( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getBackupIndexDownloadUrl( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getBackupIndexDownloadUrl( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getBackupIndexDownloadUrl( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Getiampolicy, + callback: BodyResponseCallback ): void; - getBackupIndexDownloadUrl( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupplans$Getiampolicy + | 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$Backupplans$Backups$Getbackupindexdownloadurl; + {}) as Params$Resource$Projects$Locations$Backupplans$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl; + {} as Params$Resource$Projects$Locations$Backupplans$Getiampolicy; options = {}; } @@ -2845,7 +3021,7 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+backup}:getBackupIndexDownloadUrl').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -2855,167 +3031,77 @@ export namespace gkebackup_v1 { options ), params, - requiredParams: ['backup'], - pathParams: ['backup'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists BackupPlans in a given 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$Backupplans$Backups$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://gkebackup.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 the Backups for a given BackupPlan. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$List, + list( + params: Params$Resource$Projects$Locations$Backupplans$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$List, + params?: Params$Resource$Projects$Locations$Backupplans$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$List, + params: Params$Resource$Projects$Locations$Backupplans$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupplans$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupplans$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupplans$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$Backupplans$Backups$List; + {}) as Params$Resource$Projects$Locations$Backupplans$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$List; + params = {} as Params$Resource$Projects$Locations$Backupplans$List; options = {}; } @@ -3028,7 +3114,7 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/backups').replace( + url: (rootUrl + '/v1/{+parent}/backupPlans').replace( /([^:]\/)\/+/g, '$1' ), @@ -3043,17 +3129,17 @@ export namespace gkebackup_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Update a Backup. + * Update a BackupPlan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3061,27 +3147,27 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + params: Params$Resource$Projects$Locations$Backupplans$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + params?: Params$Resource$Projects$Locations$Backupplans$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + params: Params$Resource$Projects$Locations$Backupplans$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + params: Params$Resource$Projects$Locations$Backupplans$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + params: Params$Resource$Projects$Locations$Backupplans$Patch, callback: BodyResponseCallback ): void; patch( @@ -3089,7 +3175,7 @@ export namespace gkebackup_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Patch + | Params$Resource$Projects$Locations$Backupplans$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3105,13 +3191,12 @@ export namespace gkebackup_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Patch; + {}) as Params$Resource$Projects$Locations$Backupplans$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Patch; + params = {} as Params$Resource$Projects$Locations$Backupplans$Patch; options = {}; } @@ -3154,31 +3239,31 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + params: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + params?: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + params: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + params: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + params: Params$Resource$Projects$Locations$Backupplans$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy(callback: BodyResponseCallback): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy + | Params$Resource$Projects$Locations$Backupplans$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3191,13 +3276,13 @@ export namespace gkebackup_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Backupplans$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy; + {} as Params$Resource$Projects$Locations$Backupplans$Setiampolicy; options = {}; } @@ -3243,27 +3328,27 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + params?: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + params: Params$Resource$Projects$Locations$Backupplans$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -3271,7 +3356,7 @@ export namespace gkebackup_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions + | Params$Resource$Projects$Locations$Backupplans$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3287,13 +3372,13 @@ export namespace gkebackup_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Backupplans$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions; + {} as Params$Resource$Projects$Locations$Backupplans$Testiampermissions; options = {}; } @@ -3331,52 +3416,41 @@ export namespace gkebackup_v1 { } } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Create + export interface Params$Resource$Projects$Locations$Backupplans$Create extends StandardParameters { /** - * Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan + * Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location */ - backupId?: string; + backupPlanId?: string; /** - * Required. The BackupPlan within which to create the Backup. Format: `projects/x/locations/x/backupPlans/x` + * Required. The location within which to create the BackupPlan. Format: `projects/x/locations/x` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$Backup; + requestBody?: Schema$BackupPlan; } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Delete + export interface Params$Resource$Projects$Locations$Backupplans$Delete extends StandardParameters { /** - * Optional. If provided, this value must match the current value of the target Backup's etag field or the request is rejected. + * Optional. If provided, this value must match the current value of the target BackupPlan's etag field or the request is rejected. */ etag?: string; /** - * Optional. If set to true, any VolumeBackups below this Backup will also be deleted. Otherwise, the request will only succeed if the Backup has no VolumeBackups. - */ - force?: boolean; - /** - * Required. Name of the Backup resource. Format: `projects/x/locations/x/backupPlans/x/backups/x` + * Required. Fully qualified BackupPlan name. Format: `projects/x/locations/x/backupPlans/x` */ name?: string; } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Get + export interface Params$Resource$Projects$Locations$Backupplans$Get extends StandardParameters { /** - * Required. Full name of the Backup resource. Format: `projects/x/locations/x/backupPlans/x/backups/x` + * Required. Fully qualified BackupPlan name. Format: `projects/x/locations/x/backupPlans/x` */ name?: string; } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl - extends StandardParameters { - /** - * Required. Full name of Backup resource. Format: projects/{project\}/locations/{location\}/backupPlans/{backup_plan\}/backups/{backup\} - */ - backup?: string; - } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy + export interface Params$Resource$Projects$Locations$Backupplans$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). @@ -3387,7 +3461,7 @@ export namespace gkebackup_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$List + export interface Params$Resource$Projects$Locations$Backupplans$List extends StandardParameters { /** * Optional. Field match expression used to filter the results. @@ -3402,35 +3476,31 @@ export namespace gkebackup_v1 { */ pageSize?: number; /** - * Optional. The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token. + * Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token. */ pageToken?: string; /** - * Required. The BackupPlan that contains the Backups to list. Format: `projects/x/locations/x/backupPlans/x` + * Required. The location that contains the BackupPlans to list. Format: `projects/x/locations/x` */ parent?: string; - /** - * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated. - */ - returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Patch + export interface Params$Resource$Projects$Locations$Backupplans$Patch extends StandardParameters { /** - * Output only. The fully qualified name of the Backup. `projects/x/locations/x/backupPlans/x/backups/x` + * Output only. The full name of the BackupPlan resource. Format: `projects/x/locations/x/backupPlans/x` */ name?: string; /** - * Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup. + * Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` is provided, all fields in `backup_plan` will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used to update the target BackupPlan. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$Backup; + requestBody?: Schema$BackupPlan; } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy + export interface Params$Resource$Projects$Locations$Backupplans$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. @@ -3442,7 +3512,7 @@ export namespace gkebackup_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions + export interface Params$Resource$Projects$Locations$Backupplans$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. @@ -3455,65 +3525,77 @@ export namespace gkebackup_v1 { requestBody?: Schema$TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Backupplans$Backups$Volumebackups { + export class Resource$Projects$Locations$Backupplans$Backups { context: APIRequestContext; + volumeBackups: Resource$Projects$Locations$Backupplans$Backups$Volumebackups; constructor(context: APIRequestContext) { this.context = context; + this.volumeBackups = + new Resource$Projects$Locations$Backupplans$Backups$Volumebackups( + this.context + ); } /** - * Retrieve the details of a single VolumeBackup. + * Creates a Backup for the given BackupPlan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + create( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + create( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupplans$Backups$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get; + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get; + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Create; options = {}; } @@ -3526,80 +3608,90 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/backups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Deletes an existing 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. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + delete( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupplans$Backups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy; + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Delete; options = {}; } @@ -3612,90 +3704,80 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the VolumeBackups for a given Backup. + * Retrieve the details of a single 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. */ - list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + get( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupplans$Backups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List; + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List; + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Get; options = {}; } @@ -3708,83 +3790,87 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/volumeBackups').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); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Retrieve the link to the backupIndex. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupplans$Backups$Volumebackups$Setiampolicy, + getBackupIndexDownloadUrl( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, + getBackupIndexDownloadUrl( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, + ): GaxiosPromise; + getBackupIndexDownloadUrl( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getBackupIndexDownloadUrl( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, - callback: BodyResponseCallback + getBackupIndexDownloadUrl( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + getBackupIndexDownloadUrl( + callback: BodyResponseCallback + ): void; + getBackupIndexDownloadUrl( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl + | 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$Backupplans$Backups$Volumebackups$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy; + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl; options = {}; } @@ -3797,90 +3883,1724 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+backup}:getBackupIndexDownloadUrl').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['backup'], + pathParams: ['backup'], + 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$Backupplans$Backups$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.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 the Backups for a given BackupPlan. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Update a Backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.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$Backupplans$Backups$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.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$Backupplans$Backups$Create + extends StandardParameters { + /** + * Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan + */ + backupId?: string; + /** + * Required. The BackupPlan within which to create the Backup. Format: `projects/x/locations/x/backupPlans/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Backup; + } + export interface Params$Resource$Projects$Locations$Backupplans$Backups$Delete + extends StandardParameters { + /** + * Optional. If provided, this value must match the current value of the target Backup's etag field or the request is rejected. + */ + etag?: string; + /** + * Optional. If set to true, any VolumeBackups below this Backup will also be deleted. Otherwise, the request will only succeed if the Backup has no VolumeBackups. + */ + force?: boolean; + /** + * Required. Name of the Backup resource. Format: `projects/x/locations/x/backupPlans/x/backups/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupplans$Backups$Get + extends StandardParameters { + /** + * Required. Full name of the Backup resource. Format: `projects/x/locations/x/backupPlans/x/backups/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupplans$Backups$Getbackupindexdownloadurl + extends StandardParameters { + /** + * Required. Full name of Backup resource. Format: projects/{project\}/locations/{location\}/backupPlans/{backup_plan\}/backups/{backup\} + */ + backup?: string; + } + export interface Params$Resource$Projects$Locations$Backupplans$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$Backupplans$Backups$List + extends StandardParameters { + /** + * Optional. Field match expression used to filter the results. + */ + filter?: string; + /** + * Optional. Field by which to sort the results. + */ + orderBy?: string; + /** + * Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token. + */ + pageToken?: string; + /** + * 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 { + /** + * Output only. The fully qualified name of the Backup. `projects/x/locations/x/backupPlans/x/backups/x` + */ + name?: string; + /** + * Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Backup; + } + export interface Params$Resource$Projects$Locations$Backupplans$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$Backupplans$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$Backupplans$Backups$Volumebackups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieve the details of a single VolumeBackup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.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 the VolumeBackups for a given 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. + */ + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/volumeBackups').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); + } + } + + /** + * 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$Backupplans$Backups$Volumebackups$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.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$Backupplans$Backups$Volumebackups$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.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$Backupplans$Backups$Volumebackups$Get + extends StandardParameters { + /** + * Required. Full name of the VolumeBackup resource. Format: `projects/x/locations/x/backupPlans/x/backups/x/volumeBackups/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$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$Backupplans$Backups$Volumebackups$List + extends StandardParameters { + /** + * Optional. Field match expression used to filter the results. + */ + filter?: string; + /** + * Optional. Field by which to sort the results. + */ + orderBy?: string; + /** + * Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The value of next_page_token received from a previous `ListVolumeBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeBackups` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The Backup that contains the VolumeBackups to list. Format: `projects/x/locations/x/backupPlans/x/backups/x` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$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$Backupplans$Backups$Volumebackups$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + 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://gkebackup.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://gkebackup.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://gkebackup.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://gkebackup.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$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Restorechannels { + context: APIRequestContext; + restorePlanBindings: Resource$Projects$Locations$Restorechannels$Restoreplanbindings; + constructor(context: APIRequestContext) { + this.context = context; + this.restorePlanBindings = + new Resource$Projects$Locations$Restorechannels$Restoreplanbindings( + this.context + ); + } + + /** + * Creates a new RestoreChannel in a given 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$Restorechannels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Restorechannels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Restorechannels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Restorechannels$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Restorechannels$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Restorechannels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Restorechannels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Restorechannels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/restoreChannels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes an existing RestoreChannel. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupplans$Backups$Volumebackups$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Restorechannels$Delete, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Restorechannels$Delete, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Restorechannels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Restorechannels$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Restorechannels$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - testIamPermissions( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Restorechannels$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$Backupplans$Backups$Volumebackups$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Restorechannels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions; + {} as Params$Resource$Projects$Locations$Restorechannels$Delete; options = {}; } @@ -3893,155 +5613,171 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Get - extends StandardParameters { - /** - * Required. Full name of the VolumeBackup resource. Format: `projects/x/locations/x/backupPlans/x/backups/x/volumeBackups/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$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$Backupplans$Backups$Volumebackups$List - extends StandardParameters { /** - * Optional. Field match expression used to filter the results. - */ - filter?: string; - /** - * Optional. Field by which to sort the results. - */ - orderBy?: string; - /** - * Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. - */ - pageSize?: number; - /** - * Optional. The value of next_page_token received from a previous `ListVolumeBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListVolumeBackups` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The Backup that contains the VolumeBackups to list. Format: `projects/x/locations/x/backupPlans/x/backups/x` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$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. + * Retrieve the details of a single RestoreChannel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - resource?: string; + get( + params: Params$Resource$Projects$Locations$Restorechannels$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Restorechannels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Restorechannels$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Restorechannels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Restorechannels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Restorechannels$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Restorechannels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Backupplans$Backups$Volumebackups$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Restorechannels$Get; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://gkebackup.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); + } } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Lists RestoreChannels in a given location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + list( + params: Params$Resource$Projects$Locations$Restorechannels$List, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + list( + params?: Params$Resource$Projects$Locations$Restorechannels$List, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Restorechannels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Restorechannels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Restorechannels$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Restorechannels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Restorechannels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Restorechannels$List; options = {}; } @@ -4054,79 +5790,89 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/restoreChannels').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); } } /** - * 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`. + * Update a RestoreChannel. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + patch( + params: Params$Resource$Projects$Locations$Restorechannels$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Restorechannels$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Restorechannels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Restorechannels$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Restorechannels$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Restorechannels$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Restorechannels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Restorechannels$Patch; options = {}; } @@ -4140,7 +5886,7 @@ export namespace gkebackup_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -4151,17 +5897,98 @@ export namespace gkebackup_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$Restorechannels$Create + extends StandardParameters { /** - * 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. + * Required. The location within which to create the RestoreChannel. Format: `projects/x/locations/x` + */ + parent?: string; + /** + * Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name. + */ + restoreChannelId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreChannel; + } + export interface Params$Resource$Projects$Locations$Restorechannels$Delete + extends StandardParameters { + /** + * Optional. If provided, this value must match the current value of the target RestoreChannel's etag field or the request is rejected. + */ + etag?: string; + /** + * Required. Fully qualified RestoreChannel name. Format: `projects/x/locations/x/restoreChannels/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Restorechannels$Get + extends StandardParameters { + /** + * Required. Fully qualified RestoreChannel name. Format: `projects/x/locations/x/restoreChannels/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Restorechannels$List + extends StandardParameters { + /** + * Optional. Field match expression used to filter the results. + */ + filter?: string; + /** + * Optional. Field by which to sort the results. + */ + orderBy?: string; + /** + * Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The value of next_page_token received from a previous `ListRestoreChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestoreChannels` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The location that contains the RestoreChannels to list. Format: `projects/x/locations/x` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Restorechannels$Patch + extends StandardParameters { + /** + * Identifier. The fully qualified name of the RestoreChannel. `projects/x/locations/x/restoreChannels/x` + */ + name?: string; + /** + * Optional. This is used to specify the fields to be overwritten in the RestoreChannel targeted for update. The values for each of these updated fields will be taken from the `restore_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `destination_project_id`, etc.) If no `update_mask` is provided, all fields in `restore_channel` will be written to the target RestoreChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_channel` are ignored and are not used to update the target RestoreChannel. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreChannel; + } + + export class Resource$Projects$Locations$Restorechannels$Restoreplanbindings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieve the details of a single RestorePlanBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4169,56 +5996,53 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Operations$Get, + params?: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$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 + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get, + callback: BodyResponseCallback ): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get; options = {}; } @@ -4243,17 +6067,17 @@ export namespace gkebackup_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 RestorePlanBindings in a given location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4261,56 +6085,57 @@ export namespace gkebackup_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Operations$List, + params?: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List; options = {}; } @@ -4323,7 +6148,7 @@ export namespace gkebackup_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/restorePlanBindings').replace( /([^:]\/)\/+/g, '$1' ), @@ -4333,67 +6158,52 @@ export namespace gkebackup_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$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. Fully qualified RestorePlanBinding name. Format: `projects/x/locations/x/restoreChannels/x/restorePlanBindings/x` */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Restorechannels$Restoreplanbindings$List extends StandardParameters { /** - * The standard list filter. + * Optional. Field match expression used to filter the results. */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. Field by which to sort the results. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. */ pageSize?: number; /** - * The standard list page token. + * Optional. The value of next_page_token received from a previous `ListRestorePlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestorePlanBindings` must match the call that provided the page token. */ pageToken?: string; + /** + * Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: `projects/x/locations/x/restoreChannels/x` + */ + parent?: string; } export class Resource$Projects$Locations$Restoreplans { diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index 89fd0f11f02..6c40fbba083 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -437,6 +437,10 @@ export namespace gkehub_v1 { * Multicluster Ingress-specific spec. */ multiclusteringress?: Schema$MultiClusterIngressFeatureSpec; + /** + * RBAC Role Binding Actuation feature spec + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationFeatureSpec; } /** * CommonFeatureState contains Fleet-wide Feature status information. @@ -454,6 +458,10 @@ export namespace gkehub_v1 { * FleetObservability feature state. */ fleetobservability?: Schema$FleetObservabilityFeatureState; + /** + * RBAC Role Binding Actuation feature state + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationFeatureState; /** * Output only. The "running state" of the Feature in this Fleet. */ @@ -2079,7 +2087,7 @@ export namespace gkehub_v1 { */ externalId?: string | null; /** - * Optional. Labels for this membership. + * Optional. Labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. */ labels?: {[key: string]: string} | null; /** @@ -2748,6 +2756,19 @@ export namespace gkehub_v1 { */ user?: string | null; } + /** + * **RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature. + */ + export interface Schema$RBACRoleBindingActuationFeatureSpec { + /** + * The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list. + */ + allowedCustomRoles?: string[] | null; + } + /** + * **RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state. + */ + export interface Schema$RBACRoleBindingActuationFeatureState {} /** * RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. */ @@ -2791,6 +2812,10 @@ export namespace gkehub_v1 { * Role is the type for Kubernetes roles */ export interface Schema$Role { + /** + * Optional. custom_role is the name of a custom KubernetesClusterRole to use. + */ + customRole?: string | null; /** * predefined_role is the Kubernetes default role to use */ @@ -2869,7 +2894,7 @@ export namespace gkehub_v1 { vulnerabilityMode?: string | null; } /** - * Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message. + * Condition being reported. */ export interface Schema$ServiceMeshCondition { /** @@ -2941,7 +2966,7 @@ export namespace gkehub_v1 { */ export interface Schema$ServiceMeshMembershipState { /** - * Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message. + * Output only. List of conditions reported for this membership. */ conditions?: Schema$ServiceMeshCondition[]; /** @@ -3373,6 +3398,10 @@ export namespace gkehub_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 1c68026c04f..494cc69466b 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -505,10 +505,18 @@ export namespace gkehub_v1alpha { * Namespace Actuation feature spec */ namespaceactuation?: Schema$NamespaceActuationFeatureSpec; + /** + * RBAC Role Binding Actuation feature spec + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationFeatureSpec; /** * Workload Certificate spec. */ workloadcertificate?: Schema$FeatureSpec; + /** + * Workload Identity feature spec. + */ + workloadidentity?: Schema$WorkloadIdentityFeatureSpec; } /** * CommonFeatureState contains Fleet-wide Feature status information. @@ -530,6 +538,10 @@ export namespace gkehub_v1alpha { * Namespace Actuation feature state. */ namespaceactuation?: Schema$NamespaceActuationFeatureState; + /** + * RBAC Role Binding Actuation feature state + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationFeatureState; /** * Service Mesh-specific state. */ @@ -538,6 +550,10 @@ export namespace gkehub_v1alpha { * Output only. The "running state" of the Feature in this Fleet. */ state?: Schema$FeatureState; + /** + * WorkloadIdentity fleet-level state. + */ + workloadidentity?: Schema$WorkloadIdentityFeatureState; } /** * CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet @@ -2241,7 +2257,7 @@ export namespace gkehub_v1alpha { */ externalId?: string | null; /** - * Optional. Labels for this membership. + * Optional. Labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. */ labels?: {[key: string]: string} | null; /** @@ -2437,6 +2453,10 @@ export namespace gkehub_v1alpha { * The high-level state of this Feature for a single membership. */ state?: Schema$FeatureState; + /** + * Workload Identity membership specific state. + */ + workloadidentity?: Schema$WorkloadIdentityMembershipState; } /** * **Workload Certificate**: The membership-specific input for WorkloadCertificate feature. @@ -2977,6 +2997,19 @@ export namespace gkehub_v1alpha { */ user?: string | null; } + /** + * **RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature. + */ + export interface Schema$RBACRoleBindingActuationFeatureSpec { + /** + * The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list. + */ + allowedCustomRoles?: string[] | null; + } + /** + * **RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state. + */ + export interface Schema$RBACRoleBindingActuationFeatureState {} /** * RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. */ @@ -3020,6 +3053,10 @@ export namespace gkehub_v1alpha { * Role is the type for Kubernetes roles */ export interface Schema$Role { + /** + * Optional. custom_role is the name of a custom KubernetesClusterRole to use. + */ + customRole?: string | null; /** * predefined_role is the Kubernetes default role to use */ @@ -3145,7 +3182,7 @@ export namespace gkehub_v1alpha { type?: Schema$ServiceMeshType; } /** - * Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message. + * Condition being reported. */ export interface Schema$ServiceMeshCondition { /** @@ -3196,7 +3233,7 @@ 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. + * Condition being reported. */ export interface Schema$ServiceMeshFeatureCondition { /** @@ -3259,7 +3296,7 @@ export namespace gkehub_v1alpha { */ analysisMessages?: Schema$ServiceMeshAnalysisMessage[]; /** - * Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message. + * Output only. List of conditions reported for this membership. */ conditions?: Schema$ServiceMeshCondition[]; /** @@ -3406,6 +3443,79 @@ export namespace gkehub_v1alpha { */ validator?: string | null; } + /** + * **WorkloadIdentity**: Global feature specification. + */ + export interface Schema$WorkloadIdentityFeatureSpec { + /** + * Pool to be used for Workload Identity. This pool in trust-domain mode is used with Fleet Tenancy, so that sameness can be enforced. ex: projects/example/locations/global/workloadidentitypools/custompool + */ + scopeTenancyPool?: string | null; + } + /** + * **WorkloadIdentity**: Global feature state. + */ + export interface Schema$WorkloadIdentityFeatureState { + /** + * The state of the IAM namespaces for the fleet. + */ + namespaceStateDetails?: { + [key: string]: Schema$WorkloadIdentityNamespaceStateDetail; + } | null; + /** + * Deprecated, will erase after code is changed to use the new field. + */ + namespaceStates?: {[key: string]: string} | null; + /** + * The full name of the scope-tenancy pool for the fleet. + */ + scopeTenancyWorkloadIdentityPool?: string | null; + /** + * The full name of the svc.id.goog pool for the fleet. + */ + workloadIdentityPool?: string | null; + /** + * The state of the Workload Identity Pools for the fleet. + */ + workloadIdentityPoolStateDetails?: { + [key: string]: Schema$WorkloadIdentityWorkloadIdentityPoolStateDetail; + } | null; + } + /** + * **WorkloadIdentity**: The membership-specific state for WorkloadIdentity feature. + */ + export interface Schema$WorkloadIdentityMembershipState { + /** + * Deprecated, will erase after code is changed to use the new field. + */ + description?: string | null; + } + /** + * NamespaceStateDetail represents the state of a IAM namespace. + */ + export interface Schema$WorkloadIdentityNamespaceStateDetail { + /** + * The state of the IAM namespace. + */ + code?: string | null; + /** + * A human-readable description of the current state or returned error. + */ + description?: string | null; + } + /** + * WorkloadIdentityPoolStateDetail represents the state of the Workload Identity Pools for the fleet. + */ + export interface Schema$WorkloadIdentityWorkloadIdentityPoolStateDetail { + /** + * The state of the Workload Identity Pool. + */ + code?: string | null; + /** + * A human-readable description of the current state or returned error. + */ + description?: string | null; + } export class Resource$Organizations { context: APIRequestContext; @@ -3756,6 +3866,10 @@ export namespace gkehub_v1alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index ff0201e12ca..2ec82f10a3a 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -437,6 +437,10 @@ export namespace gkehub_v1beta { * Multicluster Ingress-specific spec. */ multiclusteringress?: Schema$MultiClusterIngressFeatureSpec; + /** + * RBAC Role Binding Actuation feature spec + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationFeatureSpec; } /** * CommonFeatureState contains Fleet-wide Feature status information. @@ -454,6 +458,10 @@ export namespace gkehub_v1beta { * FleetObservability feature state. */ fleetobservability?: Schema$FleetObservabilityFeatureState; + /** + * RBAC Role Binding Actuation feature state + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationFeatureState; /** * Output only. The "running state" of the Feature in this Fleet. */ @@ -2118,7 +2126,7 @@ export namespace gkehub_v1beta { */ externalId?: string | null; /** - * Optional. Labels for this membership. + * Optional. Labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. */ labels?: {[key: string]: string} | null; /** @@ -2825,6 +2833,19 @@ export namespace gkehub_v1beta { */ user?: string | null; } + /** + * **RBAC RoleBinding Actuation**: The Hub-wide input for the RBACRoleBindingActuation feature. + */ + export interface Schema$RBACRoleBindingActuationFeatureSpec { + /** + * The list of allowed custom roles (ClusterRoles). If a ClusterRole is not part of this list, it cannot be used in a Scope RBACRoleBinding. If a ClusterRole in this list is in use, it cannot be removed from the list. + */ + allowedCustomRoles?: string[] | null; + } + /** + * **RBAC RoleBinding Actuation**: An empty state left as an example Hub-wide Feature state. + */ + export interface Schema$RBACRoleBindingActuationFeatureState {} /** * RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. */ @@ -2868,6 +2889,10 @@ export namespace gkehub_v1beta { * Role is the type for Kubernetes roles */ export interface Schema$Role { + /** + * Optional. custom_role is the name of a custom KubernetesClusterRole to use. + */ + customRole?: string | null; /** * predefined_role is the Kubernetes default role to use */ @@ -2946,7 +2971,7 @@ export namespace gkehub_v1beta { vulnerabilityMode?: string | null; } /** - * Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message. + * Condition being reported. */ export interface Schema$ServiceMeshCondition { /** @@ -3018,7 +3043,7 @@ export namespace gkehub_v1beta { */ export interface Schema$ServiceMeshMembershipState { /** - * Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message. + * Output only. List of conditions reported for this membership. */ conditions?: Schema$ServiceMeshCondition[]; /** @@ -3450,6 +3475,10 @@ export namespace gkehub_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gkehub/v1beta1.ts b/src/apis/gkehub/v1beta1.ts index ecd51a80891..a28b5f1a388 100644 --- a/src/apis/gkehub/v1beta1.ts +++ b/src/apis/gkehub/v1beta1.ts @@ -459,7 +459,7 @@ export namespace gkehub_v1beta1 { */ infrastructureType?: string | null; /** - * Optional. GCP labels for this membership. + * Optional. GCP labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. */ labels?: {[key: string]: string} | null; /** @@ -970,6 +970,10 @@ export namespace gkehub_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gkehub/v2.ts b/src/apis/gkehub/v2.ts index ae15d88983f..186f2d6b49b 100644 --- a/src/apis/gkehub/v2.ts +++ b/src/apis/gkehub/v2.ts @@ -906,6 +906,10 @@ export namespace gkehub_v2 { * Policycontroller-specific FeatureSpec. */ policycontroller?: Schema$PolicyControllerSpec; + /** + * Rbacrolebindingactuation-specific FeatureSpec. + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationSpec; /** * ServiceMesh Feature Spec. */ @@ -943,6 +947,10 @@ export namespace gkehub_v2 { * Policy Controller state */ policycontroller?: Schema$PolicyControllerState; + /** + * RBAC Role Binding Actuation state + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationState; /** * Service mesh state */ @@ -1721,6 +1729,38 @@ export namespace gkehub_v2 { */ value?: string | null; } + /** + * RBACRoleBindingState is the status of an RBACRoleBinding which exists on a membership. + */ + export interface Schema$RBACRoleBindingActuationRBACRoleBindingState { + /** + * The reason for the failure. + */ + description?: string | null; + /** + * Output only. The state of the RBACRoleBinding. + */ + state?: string | null; + /** + * The time the RBACRoleBinding status was last updated. + */ + updateTime?: string | null; + } + /** + * **RBAC RoleBinding Actuation**: The membership-specific input for RBACRoleBindingActuation feature. + */ + export interface Schema$RBACRoleBindingActuationSpec {} + /** + * **RBAC RoleBinding Actuation**: A membership-specific Feature state for the RBACRoleBindingActuation fleet feature. + */ + export interface Schema$RBACRoleBindingActuationState { + /** + * Output only. The state of RBACRoleBindings using custom roles that exist on the cluster, keyed by RBACRoleBinding resource name with format: projects/{project\}/locations/{location\}/scopes/{scope\}/rbacrolebindings/{rbacrolebinding\}. + */ + rbacrolebindingStates?: { + [key: string]: Schema$RBACRoleBindingActuationRBACRoleBindingState; + } | null; + } /** * AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration. */ @@ -2120,6 +2160,10 @@ export namespace gkehub_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gkehub/v2alpha.ts b/src/apis/gkehub/v2alpha.ts index 40594893036..79793b60aae 100644 --- a/src/apis/gkehub/v2alpha.ts +++ b/src/apis/gkehub/v2alpha.ts @@ -906,6 +906,10 @@ export namespace gkehub_v2alpha { * Policycontroller-specific FeatureSpec. */ policycontroller?: Schema$PolicyControllerSpec; + /** + * Rbacrolebindingactuation-specific FeatureSpec. + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationSpec; /** * ServiceMesh Feature Spec. */ @@ -943,6 +947,10 @@ export namespace gkehub_v2alpha { * Policy Controller state */ policycontroller?: Schema$PolicyControllerState; + /** + * RBAC Role Binding Actuation state + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationState; /** * Service mesh state */ @@ -1721,6 +1729,38 @@ export namespace gkehub_v2alpha { */ value?: string | null; } + /** + * RBACRoleBindingState is the status of an RBACRoleBinding which exists on a membership. + */ + export interface Schema$RBACRoleBindingActuationRBACRoleBindingState { + /** + * The reason for the failure. + */ + description?: string | null; + /** + * Output only. The state of the RBACRoleBinding. + */ + state?: string | null; + /** + * The time the RBACRoleBinding status was last updated. + */ + updateTime?: string | null; + } + /** + * **RBAC RoleBinding Actuation**: The membership-specific input for RBACRoleBindingActuation feature. + */ + export interface Schema$RBACRoleBindingActuationSpec {} + /** + * **RBAC RoleBinding Actuation**: A membership-specific Feature state for the RBACRoleBindingActuation fleet feature. + */ + export interface Schema$RBACRoleBindingActuationState { + /** + * Output only. The state of RBACRoleBindings using custom roles that exist on the cluster, keyed by RBACRoleBinding resource name with format: projects/{project\}/locations/{location\}/scopes/{scope\}/rbacrolebindings/{rbacrolebinding\}. + */ + rbacrolebindingStates?: { + [key: string]: Schema$RBACRoleBindingActuationRBACRoleBindingState; + } | null; + } /** * AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration. */ @@ -2120,6 +2160,10 @@ export namespace gkehub_v2alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gkehub/v2beta.ts b/src/apis/gkehub/v2beta.ts index 126bb21d5b2..ed01e537998 100644 --- a/src/apis/gkehub/v2beta.ts +++ b/src/apis/gkehub/v2beta.ts @@ -906,6 +906,10 @@ export namespace gkehub_v2beta { * Policycontroller-specific FeatureSpec. */ policycontroller?: Schema$PolicyControllerSpec; + /** + * Rbacrolebindingactuation-specific FeatureSpec. + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationSpec; /** * ServiceMesh Feature Spec. */ @@ -943,6 +947,10 @@ export namespace gkehub_v2beta { * Policy Controller state */ policycontroller?: Schema$PolicyControllerState; + /** + * RBAC Role Binding Actuation state + */ + rbacrolebindingactuation?: Schema$RBACRoleBindingActuationState; /** * Service mesh state */ @@ -1721,6 +1729,38 @@ export namespace gkehub_v2beta { */ value?: string | null; } + /** + * RBACRoleBindingState is the status of an RBACRoleBinding which exists on a membership. + */ + export interface Schema$RBACRoleBindingActuationRBACRoleBindingState { + /** + * The reason for the failure. + */ + description?: string | null; + /** + * Output only. The state of the RBACRoleBinding. + */ + state?: string | null; + /** + * The time the RBACRoleBinding status was last updated. + */ + updateTime?: string | null; + } + /** + * **RBAC RoleBinding Actuation**: The membership-specific input for RBACRoleBindingActuation feature. + */ + export interface Schema$RBACRoleBindingActuationSpec {} + /** + * **RBAC RoleBinding Actuation**: A membership-specific Feature state for the RBACRoleBindingActuation fleet feature. + */ + export interface Schema$RBACRoleBindingActuationState { + /** + * Output only. The state of RBACRoleBindings using custom roles that exist on the cluster, keyed by RBACRoleBinding resource name with format: projects/{project\}/locations/{location\}/scopes/{scope\}/rbacrolebindings/{rbacrolebinding\}. + */ + rbacrolebindingStates?: { + [key: string]: Schema$RBACRoleBindingActuationRBACRoleBindingState; + } | null; + } /** * AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration. */ @@ -2120,6 +2160,10 @@ export namespace gkehub_v2beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index fdf4b628f09..5804b5aec50 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -1924,6 +1924,10 @@ export namespace gkeonprem_v1 { * A human readable description of this VMware admin cluster. */ description?: string | null; + /** + * Enable advanced cluster. + */ + enableAdvancedCluster?: boolean | null; /** * Output only. The DNS name of VMware admin cluster's API server. */ @@ -2308,6 +2312,10 @@ export namespace gkeonprem_v1 { * Disable bundled ingress. */ disableBundledIngress?: boolean | null; + /** + * Enable advanced cluster. + */ + enableAdvancedCluster?: boolean | null; /** * Enable control plane V2. Default to false. */ @@ -3132,6 +3140,10 @@ export namespace gkeonprem_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 666cce52db9..0fc0546b468 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -502,7 +502,7 @@ export namespace gmail_v1 { */ export interface Schema$LanguageSettings { /** - * The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). + * The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. For a table of sample values, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). */ displayLanguage?: string | null; } @@ -537,7 +537,7 @@ export namespace gmail_v1 { } export interface Schema$ListDraftsResponse { /** - * List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The messages.get method can fetch additional message details. + * List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The [`messages.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/messages/get) method can fetch additional message details. */ drafts?: Schema$Draft[]; /** @@ -583,7 +583,7 @@ export namespace gmail_v1 { } export interface Schema$ListLabelsResponse { /** - * List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The labels.get method can fetch additional label details. + * List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`labels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/labels/get) method can fetch additional label details. */ labels?: Schema$Label[]; } @@ -626,7 +626,7 @@ export namespace gmail_v1 { */ resultSizeEstimate?: number | null; /** - * List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the threads.get method. + * List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the [`threads.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/threads/get) method. */ threads?: Schema$Thread[]; } @@ -3420,7 +3420,7 @@ export namespace gmail_v1 { } /** - * Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For example usage, see [Sending email](https://developers.google.com/gmail/api/guides/sending). + * Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For example usage, see [Sending email](https://developers.google.com/workspace/gmail/api/guides/sending). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3824,7 +3824,7 @@ export namespace gmail_v1 { */ includeSpamTrash?: boolean; /** - * Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/gmail/api/guides/labels#manage_labels_on_messages_threads). + * Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads). */ labelIds?: string[]; /** diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index 518bb37ae57..cdd49ca64e8 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -673,11 +673,11 @@ export namespace healthcare_v1 { */ name?: string | null; /** - * Output only. For future use. + * Output only. Whether the dataset satisfies zone isolation. */ satisfiesPzi?: boolean | null; /** - * Output only. For future use. + * Output only. Whether the dataset satisfies zone separation. */ satisfiesPzs?: boolean | null; /** @@ -2968,6 +2968,10 @@ export namespace healthcare_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 479a8075fe2..12284f363fc 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -846,11 +846,11 @@ export namespace healthcare_v1beta1 { */ name?: string | null; /** - * Output only. For future use. + * Output only. Whether the dataset satisfies zone isolation. */ satisfiesPzi?: boolean | null; /** - * Output only. For future use. + * Output only. Whether the dataset satisfies zone separation. */ satisfiesPzs?: boolean | null; /** @@ -3660,6 +3660,10 @@ export namespace healthcare_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/homegraph/v1.ts b/src/apis/homegraph/v1.ts index 6656b39efb4..fb3edd573d7 100644 --- a/src/apis/homegraph/v1.ts +++ b/src/apis/homegraph/v1.ts @@ -314,7 +314,7 @@ export namespace homegraph_v1 { states?: {[key: string]: any} | null; } /** - * Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, "123" and "456" in the following example). Example: ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", "payload": { "devices": { "states": { "123": { "on": true \}, "456": { "on": true, "brightness": 10 \} \}, \} \} \} ``` + * Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, "123" and "456" in the following example). Example: ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", "payload": { "devices": { "states": { "123": { "on": true \}, "456": { "on": true, "brightness": 10 \}, \}, \} \} \} ``` */ export interface Schema$ReportStateAndNotificationRequest { /** diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 31badfa0dd7..410df1565e2 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -147,6 +147,15 @@ export namespace iam_v1 { */ disableProgrammaticSignin?: boolean | null; } + /** + * Request message for AddAttestationRule. + */ + export interface Schema$AddAttestationRuleRequest { + /** + * Required. The attestation rule to be added. + */ + attestationRule?: Schema$AttestationRule; + } /** * Audit log information specific to Cloud IAM admin APIs. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message. */ @@ -156,6 +165,15 @@ export namespace iam_v1 { */ permissionDelta?: Schema$PermissionDelta; } + /** + * Defines which workloads can receive an identity within a pool. When an AttestationRule is defined under a managed identity, matching workloads may receive that identity. + */ + export interface Schema$AttestationRule { + /** + * Optional. A single workload operating on Google Cloud. For example: `//compute.googleapis.com/projects/123/uid/zones/us-central1-a/instances/12345`. + */ + googleCloudResource?: string | null; + } /** * Contains information about an auditable service. */ @@ -474,6 +492,45 @@ export namespace iam_v1 { */ idpMetadataXml?: string | null; } + /** + * Represents configuration for generating mutual TLS (mTLS) certificates for the identities within this pool. + */ + export interface Schema$InlineCertificateIssuanceConfig { + /** + * Optional. A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * Key format: A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * Value format: A valid CA pool resource path format like: "projects/{project\}/locations/{location\}/caPools/{ca_pool\}" * Region Matching: Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key). + */ + caPools?: {[key: string]: string} | null; + /** + * Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to ECDSA_P256. + */ + keyAlgorithm?: string | null; + /** + * Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 10 hours - 30 days. If unspecified, this will be defaulted to 24 hours. + */ + lifetime?: string | null; + /** + * Optional. Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between 10 - 80. If unspecified, this will be defaulted to 50. + */ + rotationWindowPercentage?: number | null; + } + /** + * Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration. + */ + export interface Schema$InlineTrustConfig { + /** + * Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore objects, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools. + */ + additionalTrustBundles?: {[key: string]: Schema$TrustStore} | null; + } + /** + * Intermediate CA certificates used for building the trust chain to trust anchor + */ + export interface Schema$IntermediateCA { + /** + * PEM certificate of the PKI used for validation. Must only contain one ca certificate. + */ + pemCertificate?: string | null; + } /** * Represents a public key data along with its format. */ @@ -550,6 +607,19 @@ export namespace iam_v1 { */ validationUnitName?: string | null; } + /** + * Response message for ListAttestationRules. + */ + export interface Schema$ListAttestationRulesResponse { + /** + * A list of AttestationRules. + */ + attestationRules?: Schema$AttestationRule[]; + /** + * Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response message for ListOauthClientCredentials. */ @@ -646,6 +716,32 @@ export namespace iam_v1 { */ workforcePools?: Schema$WorkforcePool[]; } + /** + * Response message for ListWorkloadIdentityPoolManagedIdentities. + */ + export interface Schema$ListWorkloadIdentityPoolManagedIdentitiesResponse { + /** + * 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; + /** + * A list of managed identities. + */ + workloadIdentityPoolManagedIdentities?: Schema$WorkloadIdentityPoolManagedIdentity[]; + } + /** + * Response message for ListWorkloadIdentityPoolNamespaces. + */ + export interface Schema$ListWorkloadIdentityPoolNamespacesResponse { + /** + * 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; + /** + * A list of namespaces. + */ + workloadIdentityPoolNamespaces?: Schema$WorkloadIdentityPoolNamespace[]; + } /** * Response message for ListWorkloadIdentityPoolProviderKeys. */ @@ -764,7 +860,7 @@ export namespace iam_v1 { */ allowedAudiences?: string[] | null; /** - * Required. The OIDC issuer URL. Must be an HTTPS endpoint. + * Required. The OIDC issuer URL. Must be an HTTPS endpoint. Used per OpenID Connect Discovery 1.0 spec to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'. */ issuerUri?: string | null; /** @@ -830,6 +926,15 @@ export namespace iam_v1 { */ verb?: string | null; } + /** + * The Google Cloud service that owns this namespace. + */ + export interface Schema$OwnerService { + /** + * Required. The service agent principal subject, e.g. "serviceAccount:service-1234@gcp-sa-gkehub.iam.gserviceaccount.com". + */ + principalSubject?: string | null; + } /** * The service account patch request. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response. */ @@ -1006,6 +1111,15 @@ export namespace iam_v1 { */ exclusiveAction?: string | null; } + /** + * Request message for RemoveAttestationRule. + */ + export interface Schema$RemoveAttestationRuleRequest { + /** + * Required. The attestation rule to be removed. + */ + attestationRule?: Schema$AttestationRule; + } /** * A role in the Identity and Access Management API. */ @@ -1151,6 +1265,15 @@ export namespace iam_v1 { */ domain?: string | null; } + /** + * Request message for SetAttestationRules. + */ + export interface Schema$SetAttestationRulesRequest { + /** + * Required. The attestation rules to be set. At most 50 attestation rules can be set. + */ + attestationRules?: Schema$AttestationRule[]; + } /** * Request message for `SetIamPolicy` method. */ @@ -1243,6 +1366,28 @@ export namespace iam_v1 { */ permissions?: string[] | null; } + /** + * Represents a root of trust. + */ + export interface Schema$TrustAnchor { + /** + * PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert). + */ + pemCertificate?: string | null; + } + /** + * Trust store that contains trust anchors and optional intermediate CAs used in PKI to build trust chain and verify client's identity. + */ + export interface Schema$TrustStore { + /** + * Optional. Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: * Intermediate CAs are only supported when configuring x509 federation. + */ + intermediateCas?: Schema$IntermediateCA[]; + /** + * Required. List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here. + */ + trustAnchors?: Schema$TrustAnchor[]; + } /** * Request message for UndeleteOauthClient. */ @@ -1282,6 +1427,14 @@ export namespace iam_v1 { * Request message for UndeleteWorkforcePoolSubject. */ export interface Schema$UndeleteWorkforcePoolSubjectRequest {} + /** + * Request message for UndeleteWorkloadIdentityPoolManagedIdentity. + */ + export interface Schema$UndeleteWorkloadIdentityPoolManagedIdentityRequest {} + /** + * Request message for UndeleteWorkloadIdentityPoolNamespace. + */ + export interface Schema$UndeleteWorkloadIdentityPoolNamespaceRequest {} /** * Request message for UndeleteWorkloadIdentityPoolProviderKey. */ @@ -1438,6 +1591,18 @@ export namespace iam_v1 { * Output only. Time after which the workload identity pool will be permanently purged and cannot be recovered. */ expireTime?: string | null; + /** + * Optional. Defines the Certificate Authority (CA) pool resources and configurations required for issuance and rotation of mTLS workload certificates. + */ + inlineCertificateIssuanceConfig?: Schema$InlineCertificateIssuanceConfig; + /** + * Optional. Represents config to add additional trusted trust domains. + */ + inlineTrustConfig?: Schema$InlineTrustConfig; + /** + * Immutable. The mode the pool is operating in. + */ + mode?: string | null; /** * Output only. The resource name of the pool. */ @@ -1447,6 +1612,60 @@ export namespace iam_v1 { */ state?: string | null; } + /** + * Represents a managed identity for a workload identity pool namespace. + */ + export interface Schema$WorkloadIdentityPoolManagedIdentity { + /** + * A description of the managed identity. Cannot exceed 256 characters. + */ + description?: string | null; + /** + * Whether the managed identity is disabled. If disabled, credentials may no longer be issued for the identity, however existing credentials will still be accepted until they expire. + */ + disabled?: boolean | null; + /** + * Output only. Time after which the managed identity will be permanently purged and cannot be recovered. + */ + expireTime?: string | null; + /** + * Output only. The resource name of the managed identity. + */ + name?: string | null; + /** + * Output only. The state of the managed identity. + */ + state?: string | null; + } + /** + * Represents a namespace for a workload identity pool. Namespaces are used to segment identities within the pool. + */ + export interface Schema$WorkloadIdentityPoolNamespace { + /** + * A description of the namespace. Cannot exceed 256 characters. + */ + description?: string | null; + /** + * Whether the namespace is disabled. If disabled, credentials may no longer be issued for identities within this namespace, however existing credentials will still be accepted until they expire. + */ + disabled?: boolean | null; + /** + * Output only. Time after which the namespace will be permanently purged and cannot be recovered. + */ + expireTime?: string | null; + /** + * Output only. The resource name of the namespace. + */ + name?: string | null; + /** + * Output only. The Google Cloud service that owns this namespace. + */ + ownerService?: Schema$OwnerService; + /** + * Output only. The state of the namespace. + */ + state?: string | null; + } /** * Metadata for long-running WorkloadIdentityPool operations. */ @@ -1499,6 +1718,10 @@ export namespace iam_v1 { * Output only. The state of the provider. */ state?: string | null; + /** + * An X.509-type identity provider. + */ + x509?: Schema$X509; } /** * Represents a public key configuration for your workload identity pool provider. The key can be configured in your identity provider to encrypt the SAML assertions. Google holds the corresponding private key which it uses to decrypt encrypted tokens. @@ -1525,6 +1748,15 @@ export namespace iam_v1 { */ use?: string | null; } + /** + * An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA. + */ + export interface Schema$X509 { + /** + * Required. A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported. + */ + trustStore?: Schema$TrustStore; + } export class Resource$Iampolicies { context: APIRequestContext; @@ -6619,6 +6851,95 @@ export namespace iam_v1 { } } + /** + * Gets IAM policies for one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists all non-deleted WorkloadIdentityPools in a project. If `show_deleted` is set to `true`, then deleted pools are also listed. * @@ -6804,48 +7125,233 @@ export namespace iam_v1 { } /** - * Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago. + * Sets IAM policies on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Undelete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - undelete( - params?: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - undelete( - params: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy, + callback: BodyResponseCallback ): void; - undelete(callback: BodyResponseCallback): void; - undelete( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Workloadidentitypools$Undelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.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 the caller's permissions on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.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); + } + } + + /** + * Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Undelete, + options: StreamMethodOptions + ): GaxiosPromise; + undelete( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, + options?: MethodOptions + ): GaxiosPromise; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Undelete, + callback: BodyResponseCallback + ): void; + undelete(callback: BodyResponseCallback): void; + undelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Undelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || @@ -6923,6 +7429,18 @@ export namespace iam_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$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$Locations$Workloadidentitypools$List extends StandardParameters { /** @@ -6958,6 +7476,30 @@ export namespace iam_v1 { */ requestBody?: Schema$WorkloadIdentityPool; } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$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$Workloadidentitypools$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 interface Params$Resource$Projects$Locations$Workloadidentitypools$Undelete extends StandardParameters { /** @@ -6986,23 +7528,1687 @@ export namespace iam_v1 { this.context ); } - } - export class Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities { - context: APIRequestContext; - operations: Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Operations; - workloadSources: Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Workloadsources; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Operations( - this.context - ); - this.workloadSources = - new Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Workloadsources( - this.context - ); - } + /** + * Creates a new WorkloadIdentityPoolNamespace in a WorkloadIdentityPool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/namespaces').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 WorkloadIdentityPoolNamespace. You can undelete a namespace for 30 days. After 30 days, deletion is permanent. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').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 an individual WorkloadIdentityPoolNamespace. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').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 non-deleted WorkloadIdentityPoolNamespaces in a workload identity pool. If `show_deleted` is set to `true`, then deleted namespaces are also listed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/namespaces').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing WorkloadIdentityPoolNamespace in a WorkloadIdentityPool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').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); + } + } + + /** + * Undeletes a WorkloadIdentityPoolNamespace, as long as it was deleted fewer than 30 days ago. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Undelete, + options: StreamMethodOptions + ): GaxiosPromise; + undelete( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete, + options?: MethodOptions + ): GaxiosPromise; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete, + callback: BodyResponseCallback + ): void; + undelete(callback: BodyResponseCallback): void; + undelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}: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$Workloadidentitypools$Namespaces$Create + extends StandardParameters { + /** + * Required. The parent resource to create the namespace in. The only supported location is `global`. + */ + parent?: string; + /** + * Required. The ID to use for the namespace. This value must: * contain at most 63 characters * contain only lowercase alphanumeric characters or `-` * start with an alphanumeric character * end with an alphanumeric character The prefix "gcp-" will be reserved for future uses. + */ + workloadIdentityPoolNamespaceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkloadIdentityPoolNamespace; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Delete + extends StandardParameters { + /** + * Required. The name of the namespace to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Get + extends StandardParameters { + /** + * Required. The name of the namespace to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$List + extends StandardParameters { + /** + * The maximum number of namespaces to return. If unspecified, at most 50 namespaces are returned. The maximum value is 1000; values above are 1000 truncated to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListWorkloadIdentityPoolNamespaces` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent resource to list namespaces for. + */ + parent?: string; + /** + * Whether to return soft-deleted namespaces. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Patch + extends StandardParameters { + /** + * Output only. The resource name of the namespace. + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkloadIdentityPoolNamespace; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Undelete + extends StandardParameters { + /** + * Required. The name of the namespace to undelete. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UndeleteWorkloadIdentityPoolNamespaceRequest; + } + + export class Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities { + context: APIRequestContext; + operations: Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Operations; + workloadSources: Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Workloadsources; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Operations( + this.context + ); + this.workloadSources = + new Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Workloadsources( + this.context + ); + } + + /** + * Add an AttestationRule on a WorkloadIdentityPoolManagedIdentity. The total attestation rules after addition must not exceed 50. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule, + options: StreamMethodOptions + ): GaxiosPromise; + addAttestationRule( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule, + options?: MethodOptions + ): GaxiosPromise; + addAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule, + callback: BodyResponseCallback + ): void; + addAttestationRule(callback: BodyResponseCallback): void; + addAttestationRule( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:addAttestationRule').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); + } + } + + /** + * Creates a new WorkloadIdentityPoolManagedIdentity in a WorkloadIdentityPoolNamespace. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Managedidentities$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/managedIdentities').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 WorkloadIdentityPoolManagedIdentity. You can undelete a managed identity for 30 days. After 30 days, deletion is permanent. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Managedidentities$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').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 an individual WorkloadIdentityPoolManagedIdentity. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Managedidentities$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').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 non-deleted WorkloadIdentityPoolManagedIdentitys in a namespace. If `show_deleted` is set to `true`, then deleted managed identites are also listed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Managedidentities$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/managedIdentities').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 + ); + } + } + + /** + * List all AttestationRule on a WorkloadIdentityPoolManagedIdentity. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules, + options: StreamMethodOptions + ): GaxiosPromise; + listAttestationRules( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules, + options?: MethodOptions + ): GaxiosPromise; + listAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules, + callback: BodyResponseCallback + ): void; + listAttestationRules( + callback: BodyResponseCallback + ): void; + listAttestationRules( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:listAttestationRules').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 + ); + } + } + + /** + * Updates an existing WorkloadIdentityPoolManagedIdentity in a WorkloadIdentityPoolNamespace. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Managedidentities$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').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); + } + } + + /** + * Remove an AttestationRule on a WorkloadIdentityPoolManagedIdentity. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule, + options: StreamMethodOptions + ): GaxiosPromise; + removeAttestationRule( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule, + options?: MethodOptions + ): GaxiosPromise; + removeAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAttestationRule( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule, + callback: BodyResponseCallback + ): void; + removeAttestationRule( + callback: BodyResponseCallback + ): void; + removeAttestationRule( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:removeAttestationRule').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); + } + } + + /** + * Set all AttestationRule on a WorkloadIdentityPoolManagedIdentity. A maximum of 50 AttestationRules can be 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. + */ + setAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules, + options: StreamMethodOptions + ): GaxiosPromise; + setAttestationRules( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules, + options?: MethodOptions + ): GaxiosPromise; + setAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAttestationRules( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules, + callback: BodyResponseCallback + ): void; + setAttestationRules(callback: BodyResponseCallback): void; + setAttestationRules( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setAttestationRules').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); + } + } + + /** + * Undeletes a WorkloadIdentityPoolManagedIdentity, as long as it was deleted fewer than 30 days ago. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadidentitypools$Namespaces$Managedidentities$Undelete, + options: StreamMethodOptions + ): GaxiosPromise; + undelete( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete, + options?: MethodOptions + ): GaxiosPromise; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete, + callback: BodyResponseCallback + ): void; + undelete(callback: BodyResponseCallback): void; + undelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}: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$Workloadidentitypools$Namespaces$Managedidentities$Addattestationrule + extends StandardParameters { + /** + * Required. The resource name of the managed identity or namespace resource to add an attestation rule to. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddAttestationRuleRequest; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Create + extends StandardParameters { + /** + * Required. The parent resource to create the manage identity in. The only supported location is `global`. + */ + parent?: string; + /** + * Required. The ID to use for the managed identity. This value must: * contain at most 63 characters * contain only lowercase alphanumeric characters or `-` * start with an alphanumeric character * end with an alphanumeric character The prefix "gcp-" will be reserved for future uses. + */ + workloadIdentityPoolManagedIdentityId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkloadIdentityPoolManagedIdentity; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Delete + extends StandardParameters { + /** + * Required. The name of the managed identity to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Get + extends StandardParameters { + /** + * Required. The name of the managed identity to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$List + extends StandardParameters { + /** + * The maximum number of managed identities to return. If unspecified, at most 50 managed identities are returned. The maximum value is 1000; values above are 1000 truncated to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListWorkloadIdentityPoolManagedIdentities` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent resource to list managed identities for. + */ + parent?: string; + /** + * Whether to return soft-deleted managed identities. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Listattestationrules + extends StandardParameters { + /** + * Optional. A query filter. Supports the following function: * `container_ids()`: Returns only the AttestationRules under the specific container ids. The function expects a comma-delimited list with only project numbers and must use the format `projects/`. For example: `container_ids(projects/, projects/,...)`. + */ + filter?: string; + /** + * Optional. The maximum number of AttestationRules to return. If unspecified, at most 50 AttestationRules are returned. The maximum value is 100; values above 100 are truncated to 100. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListWorkloadIdentityPoolProviderKeys` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the managed identity or namespace resource to list attestation rules of. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Patch + extends StandardParameters { + /** + * Output only. The resource name of the managed identity. + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkloadIdentityPoolManagedIdentity; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Removeattestationrule + extends StandardParameters { + /** + * Required. The resource name of the managed identity or namespace resource to remove an attestation rule from. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveAttestationRuleRequest; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Setattestationrules + extends StandardParameters { + /** + * Required. The resource name of the managed identity or namespace resource to add an attestation rule to. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetAttestationRulesRequest; + } + export interface Params$Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Undelete + extends StandardParameters { + /** + * Required. The name of the managed identity to undelete. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UndeleteWorkloadIdentityPoolManagedIdentityRequest; } export class Resource$Projects$Locations$Workloadidentitypools$Namespaces$Managedidentities$Operations { @@ -10193,7 +12399,7 @@ export namespace iam_v1 { } /** - * **Note:** This method is deprecated. Use the [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount. + * Signs a blob using the system-managed private key for a ServiceAccount. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10281,7 +12487,7 @@ export namespace iam_v1 { } /** - * **Note:** This method is deprecated. Use the [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. + * Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index f6af98e8d9f..fb9e8c00899 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -112,6 +112,7 @@ export namespace iamcredentials_v1 { */ export class Iamcredentials { context: APIRequestContext; + locations: Resource$Locations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace iamcredentials_v1 { google, }; + this.locations = new Resource$Locations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -161,10 +163,14 @@ export namespace iamcredentials_v1 { * Include the service account email in the token. If set to `true`, the token will contain `email` and `email_verified` claims. */ includeEmail?: boolean | null; + /** + * Include the organization number of the service account in the token. If set to `true`, the token will contain a `google.organization_number` claim. The value of the claim will be `null` if the service account isn't associated with an organization. + */ + organizationNumberIncluded?: boolean | null; } export interface Schema$GenerateIdTokenResponse { /** - * The OpenId Connect ID token. + * The OpenId Connect ID token. The token is a JSON Web Token (JWT) that contains a payload with claims. See the [JSON Web Token spec](https://tools.ietf.org/html/rfc7519) for more information. Here is an example of a decoded JWT payload: ``` { "iss": "https://accounts.google.com", "iat": 1496953245, "exp": 1496953245, "aud": "https://www.example.com", "sub": "107517467455664443765", "azp": "107517467455664443765", "email": "my-iam-account@my-project.iam.gserviceaccount.com", "email_verified": true, "google": { "organization_number": 123456 \} \} ``` */ token?: string | null; } @@ -221,18 +227,293 @@ export namespace iamcredentials_v1 { */ signedJwt?: string | null; } + /** + * Represents a list of allowed locations for given workforce pool. + */ + export interface Schema$WorkforcePoolAllowedLocations { + /** + * Output only. The hex encoded bitmap of the trust boundary locations + */ + encodedLocations?: string | null; + /** + * Output only. The human readable trust boundary locations. For example, ["us-central1", "europe-west1"] + */ + locations?: string[] | null; + } + /** + * Represents a list of allowed locations for given workload identity pool. + */ + export interface Schema$WorkloadIdentityPoolAllowedLocations { + /** + * Output only. The hex encoded bitmap of the trust boundary locations + */ + encodedLocations?: string | null; + /** + * Output only. The human readable trust boundary locations. For example, ["us-central1", "europe-west1"] + */ + locations?: string[] | null; + } + + export class Resource$Locations { + context: APIRequestContext; + workforcePools: Resource$Locations$Workforcepools; + constructor(context: APIRequestContext) { + this.context = context; + this.workforcePools = new Resource$Locations$Workforcepools(this.context); + } + } + + export class Resource$Locations$Workforcepools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the trust boundary info for a given workforce pool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAllowedLocations( + params: Params$Resource$Locations$Workforcepools$Getallowedlocations, + options: StreamMethodOptions + ): GaxiosPromise; + getAllowedLocations( + params?: Params$Resource$Locations$Workforcepools$Getallowedlocations, + options?: MethodOptions + ): GaxiosPromise; + getAllowedLocations( + params: Params$Resource$Locations$Workforcepools$Getallowedlocations, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAllowedLocations( + params: Params$Resource$Locations$Workforcepools$Getallowedlocations, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAllowedLocations( + params: Params$Resource$Locations$Workforcepools$Getallowedlocations, + callback: BodyResponseCallback + ): void; + getAllowedLocations( + callback: BodyResponseCallback + ): void; + getAllowedLocations( + paramsOrCallback?: + | Params$Resource$Locations$Workforcepools$Getallowedlocations + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Locations$Workforcepools$Getallowedlocations; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Locations$Workforcepools$Getallowedlocations; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://iamcredentials.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/allowedLocations').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$Locations$Workforcepools$Getallowedlocations + extends StandardParameters { + /** + * Required. Resource name of workforce pool. + */ + name?: string; + } export class Resource$Projects { context: APIRequestContext; + locations: Resource$Projects$Locations; serviceAccounts: Resource$Projects$Serviceaccounts; constructor(context: APIRequestContext) { this.context = context; + this.locations = new Resource$Projects$Locations(this.context); this.serviceAccounts = new Resource$Projects$Serviceaccounts( this.context ); } } + export class Resource$Projects$Locations { + context: APIRequestContext; + workloadIdentityPools: Resource$Projects$Locations$Workloadidentitypools; + constructor(context: APIRequestContext) { + this.context = context; + this.workloadIdentityPools = + new Resource$Projects$Locations$Workloadidentitypools(this.context); + } + } + + export class Resource$Projects$Locations$Workloadidentitypools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the trust boundary info for a given workload identity pool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAllowedLocations( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, + options: StreamMethodOptions + ): GaxiosPromise; + getAllowedLocations( + params?: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, + options?: MethodOptions + ): GaxiosPromise; + getAllowedLocations( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAllowedLocations( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAllowedLocations( + params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, + callback: BodyResponseCallback + ): void; + getAllowedLocations( + callback: BodyResponseCallback + ): void; + getAllowedLocations( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://iamcredentials.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/allowedLocations').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$Workloadidentitypools$Getallowedlocations + extends StandardParameters { + /** + * Required. Resource name of workload identity pool. + */ + name?: string; + } + export class Resource$Projects$Serviceaccounts { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index ae8fd3c77c5..376baaef247 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -528,7 +528,7 @@ export namespace iap_v1 { export interface Schema$ResetIdentityAwareProxyClientSecretRequest {} export interface Schema$Resource { /** - * The proto or JSON formatted expected next state of the resource, wrapped in a google.protobuf.Any proto, against which the policy rules are evaluated. Services not integrated with custom org policy can omit this field. Services integrated with custom org policy must populate this field for all requests where the API call changes the state of the resource. Custom org policy backend uses these attributes to enforce custom org policies. For create operations, GCP service is expected to pass resource from customer request as is. For update/patch operations, GCP service is expected to compute the next state with the patch provided by the user. See go/custom-constraints-org-policy-integration-guide for additional details. + * The proto or JSON formatted expected next state of the resource, wrapped in a google.protobuf.Any proto, against which the policy rules are evaluated. Services not integrated with custom org policy can omit this field. Services integrated with custom org policy must populate this field for all requests where the API call changes the state of the resource. Custom org policy backend uses these attributes to enforce custom org policies. For create operations, GCP service is expected to pass resource from customer request as is. For update/patch operations, GCP service is expected to compute the next state with the patch provided by the user. See go/federated-custom-org-policy-integration-guide for additional details. */ expectedNextState?: {[key: string]: any} | null; /** diff --git a/src/apis/ids/v1.ts b/src/apis/ids/v1.ts index 3046d41df72..7a0d642cb99 100644 --- a/src/apis/ids/v1.ts +++ b/src/apis/ids/v1.ts @@ -543,6 +543,10 @@ export namespace ids_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/index.ts b/src/apis/index.ts index d11944c1608..bdb945b49c9 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -493,6 +493,10 @@ import { } from './networkservices'; import {VERSIONS as notebooksVersions, notebooks} from './notebooks'; import {VERSIONS as oauth2Versions, oauth2} from './oauth2'; +import { + VERSIONS as observabilityVersions, + observability, +} from './observability'; import { VERSIONS as ondemandscanningVersions, ondemandscanning, @@ -653,6 +657,10 @@ import {VERSIONS as speechVersions, speech} from './speech'; import {VERSIONS as sqlVersions, sql} from './sql'; import {VERSIONS as sqladminVersions, sqladmin} from './sqladmin'; import {VERSIONS as storageVersions, storage} from './storage'; +import { + VERSIONS as storagebatchoperationsVersions, + storagebatchoperations, +} from './storagebatchoperations'; import { VERSIONS as storagetransferVersions, storagetransfer, @@ -945,6 +953,7 @@ export const APIS: APIList = { networkservices: networkservicesVersions, notebooks: notebooksVersions, oauth2: oauth2Versions, + observability: observabilityVersions, ondemandscanning: ondemandscanningVersions, oracledatabase: oracledatabaseVersions, orgpolicy: orgpolicyVersions, @@ -1009,6 +1018,7 @@ export const APIS: APIList = { sql: sqlVersions, sqladmin: sqladminVersions, storage: storageVersions, + storagebatchoperations: storagebatchoperationsVersions, storagetransfer: storagetransferVersions, streetviewpublish: streetviewpublishVersions, sts: stsVersions, @@ -1255,6 +1265,7 @@ export class GeneratedAPIs { networkservices = networkservices; notebooks = notebooks; oauth2 = oauth2; + observability = observability; ondemandscanning = ondemandscanning; oracledatabase = oracledatabase; orgpolicy = orgpolicy; @@ -1319,6 +1330,7 @@ export class GeneratedAPIs { sql = sql; sqladmin = sqladmin; storage = storage; + storagebatchoperations = storagebatchoperations; storagetransfer = storagetransfer; streetviewpublish = streetviewpublish; sts = sts; diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index 883dc8e8b91..ce1e79d96fc 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -965,15 +965,15 @@ export namespace jobs_v3 { minValue?: number | 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 + * 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 or 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$PostalAddress { /** - * 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -981,7 +981,7 @@ export namespace jobs_v3 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -989,7 +989,7 @@ export namespace jobs_v3 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -1005,11 +1005,11 @@ export namespace jobs_v3 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index e31be85ca5f..a8638c0fdee 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -1029,15 +1029,15 @@ export namespace jobs_v3p1beta1 { response?: {[key: string]: any} | 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 + * 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 or 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$PostalAddress { /** - * 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -1045,7 +1045,7 @@ export namespace jobs_v3p1beta1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -1053,7 +1053,7 @@ export namespace jobs_v3p1beta1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -1069,11 +1069,11 @@ export namespace jobs_v3p1beta1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/jobs/v4.ts b/src/apis/jobs/v4.ts index 529dbca2308..86c2cb7ea0a 100644 --- a/src/apis/jobs/v4.ts +++ b/src/apis/jobs/v4.ts @@ -955,15 +955,15 @@ export namespace jobs_v4 { response?: {[key: string]: any} | 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 + * 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 or 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$PostalAddress { /** - * 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -971,7 +971,7 @@ export namespace jobs_v4 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -979,7 +979,7 @@ export namespace jobs_v4 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -995,11 +995,11 @@ export namespace jobs_v4 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/lifesciences/v2beta.ts b/src/apis/lifesciences/v2beta.ts index ea9acb59841..54b905361dc 100644 --- a/src/apis/lifesciences/v2beta.ts +++ b/src/apis/lifesciences/v2beta.ts @@ -1014,6 +1014,10 @@ export namespace lifesciences_v2beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 26806fd2000..5313e964c59 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -420,7 +420,7 @@ export namespace logging_v2 { */ linkId?: string | null; /** - * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" */ parent?: string | null; } @@ -2885,6 +2885,10 @@ export namespace logging_v2 { } export interface Params$Resource$Billingaccounts$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -4092,7 +4096,7 @@ export namespace logging_v2 { */ linkId?: string; /** - * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" */ parent?: string; @@ -8433,6 +8437,10 @@ export namespace logging_v2 { } export interface Params$Resource$Folders$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -9629,7 +9637,7 @@ export namespace logging_v2 { */ linkId?: string; /** - * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" */ parent?: string; @@ -13069,6 +13077,10 @@ export namespace logging_v2 { name?: string; } export interface Params$Resource$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -14265,7 +14277,7 @@ export namespace logging_v2 { */ linkId?: string; /** - * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" */ parent?: string; @@ -16869,6 +16881,10 @@ export namespace logging_v2 { } export interface Params$Resource$Organizations$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -18075,7 +18091,7 @@ export namespace logging_v2 { */ linkId?: string; /** - * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" */ parent?: string; @@ -22251,6 +22267,10 @@ export namespace logging_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -23447,7 +23467,7 @@ export namespace logging_v2 { */ linkId?: string; /** - * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + * Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" */ parent?: string; diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index fa7b2213326..923b0d7d64e 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -407,6 +407,48 @@ export namespace looker_v1 { */ userMetadata?: Schema$UserMetadata; } + /** + * The details of a backup resource. + */ + export interface Schema$InstanceBackup { + /** + * Output only. The time when the backup was started. + */ + createTime?: string | null; + /** + * Output only. Current status of the CMEK encryption + */ + encryptionConfig?: Schema$EncryptionConfig; + /** + * Output only. The time when the backup will be deleted. + */ + expireTime?: string | null; + /** + * Immutable. The relative resource name of the backup, in the following form: `projects/{project_number\}/locations/{location_id\}/instances/{instance_id\}/backups/{backup\}` + */ + name?: string | null; + /** + * Output only. The current state of the backup. + */ + state?: string | null; + } + /** + * Response from listing Looker instance backups. + */ + export interface Schema$ListInstanceBackupsResponse { + /** + * The list of instances matching the request filters, up to the requested `page_size`. + */ + instanceBackups?: Schema$InstanceBackup[]; + /** + * If provided, a page token that can look up the next `page_size` results. If empty, the results list is exhausted. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response from ListInstances. */ @@ -593,6 +635,15 @@ export namespace looker_v1 { * Request options for restarting an instance. */ export interface Schema$RestartInstanceRequest {} + /** + * Request options for restoring an instance + */ + export interface Schema$RestoreInstanceRequest { + /** + * Required. Backup being used to restore the instance Format: projects/{project\}/locations/{location\}/instances/{instance\}/backups/{backup\} + */ + backup?: string | null; + } /** * Service attachment configuration. */ @@ -875,6 +926,10 @@ export namespace looker_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -895,8 +950,12 @@ 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 + ); } /** @@ -1592,6 +1651,94 @@ export namespace looker_v1 { return createAPIRequest(parameters); } } + + /** + * Restore Looker 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. + */ + restore( + params: Params$Resource$Projects$Locations$Instances$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Projects$Locations$Instances$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Instances$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Instances$Restore, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Instances$Restore, + callback: BodyResponseCallback + ): void; + restore(callback: BodyResponseCallback): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://looker.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Instances$Create @@ -1695,6 +1842,426 @@ export namespace looker_v1 { */ requestBody?: Schema$RestartInstanceRequest; } + export interface Params$Resource$Projects$Locations$Instances$Restore + extends StandardParameters { + /** + * Required. Instance being restored Format: projects/{project\}/locations/{location\}/instances/{instance\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreInstanceRequest; + } + + export class Resource$Projects$Locations$Instances$Backups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Backup Looker 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. + */ + create( + params: Params$Resource$Projects$Locations$Instances$Backups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Instances$Backups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Instances$Backups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Instances$Backups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Instances$Backups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Backups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Backups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Instances$Backups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://looker.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); + } + } + + /** + * Delete backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Instances$Backups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Instances$Backups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Instances$Backups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Instances$Backups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Instances$Backups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Backups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Backups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Instances$Backups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://looker.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); + } + } + + /** + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instances$Backups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Instances$Backups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Instances$Backups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Instances$Backups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Instances$Backups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Backups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Backups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Backups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://looker.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List backups of Looker 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. + */ + list( + params: Params$Resource$Projects$Locations$Instances$Backups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Instances$Backups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Instances$Backups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Instances$Backups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Instances$Backups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Backups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Backups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Instances$Backups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://looker.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backups').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$Instances$Backups$Create + extends StandardParameters { + /** + * Required. Format: projects/{project\}/locations/{location\}/instances/{instance\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceBackup; + } + export interface Params$Resource$Projects$Locations$Instances$Backups$Delete + extends StandardParameters { + /** + * Required. Format: projects/{project\}/locations/{location\}/instances/{instance\}/backups/{backup\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Instances$Backups$Get + extends StandardParameters { + /** + * Required. Format: `projects/{project\}/locations/{location\}/instances/{instance\}/backups/{backup\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Instances$Backups$List + extends StandardParameters { + /** + * Sort results. Default order is "create_time desc". Other supported fields are "state" and "expire_time". https://google.aip.dev/132#ordering + */ + orderBy?: string; + /** + * The maximum number of instances to return. + */ + pageSize?: number; + /** + * A page token received from a previous ListInstances request. + */ + pageToken?: string; + /** + * Required. Format: projects/{project\}/locations/{location\}/instances/{instance\}. + */ + parent?: string; + } export class Resource$Projects$Locations$Operations { context: APIRequestContext; diff --git a/src/apis/managedkafka/v1.ts b/src/apis/managedkafka/v1.ts index 67f2b9ff7cb..04a1f25a9c2 100644 --- a/src/apis/managedkafka/v1.ts +++ b/src/apis/managedkafka/v1.ts @@ -133,6 +133,69 @@ export namespace managedkafka_v1 { */ networkConfigs?: Schema$NetworkConfig[]; } + /** + * Represents the set of ACLs for a given Kafka Resource Pattern, which consists of resource_type, resource_name and pattern_type. + */ + export interface Schema$Acl { + /** + * Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100. + */ + aclEntries?: Schema$AclEntry[]; + /** + * Optional. `etag` is used for concurrency control. An `etag` is returned in the response to `GetAcl` and `CreateAcl`. Callers are required to put that etag in the request to `UpdateAcl` to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster. A terminal 'T' character in the etag indicates that the AclEntries were truncated; more entries for the Acl exist on the Kafka Cluster, but can't be returned in the Acl due to repeated field limits. + */ + etag?: string | null; + /** + * Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/acls/{acl_id\} The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name\}` `consumerGroup/{resource_name\}` `transactionalId/{resource_name\}` For acls on all resources that match a prefix: `topicPrefixed/{resource_name\}` `consumerGroupPrefixed/{resource_name\}` `transactionalIdPrefixed/{resource_name\}` For acls on all resources of a given type (i.e. the wildcard literal "*"): `allTopics` (represents `topic/x`) `allConsumerGroups` (represents `consumerGroup/x`) `allTransactionalIds` (represents `transactionalId/x`) + */ + name?: string | null; + /** + * Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED. + */ + patternType?: string | null; + /** + * Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*". + */ + resourceName?: string | null; + /** + * Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID. + */ + resourceType?: string | null; + } + /** + * Represents the access granted for a given Resource Pattern in an ACL. + */ + export interface Schema$AclEntry { + /** + * Required. The host. Must be set to "*" for Managed Service for Apache Kafka. + */ + host?: string | null; + /** + * Required. The operation type. Allowed values are (case insensitive): ALL, READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION, DESCRIBE_CONFIGS, ALTER_CONFIGS, and IDEMPOTENT_WRITE. See https://kafka.apache.org/documentation/#operations_resources_and_protocols for valid combinations of resource_type and operation for different Kafka API requests. + */ + operation?: string | null; + /** + * Required. The permission type. Accepted values are (case insensitive): ALLOW, DENY. + */ + permissionType?: string | null; + /** + * Required. The principal. Specified as Google Cloud account, with the Kafka StandardAuthorizer prefix "User:". For example: "User:test-kafka-client@test-project.iam.gserviceaccount.com". Can be the wildcard "User:*" to refer to all users. + */ + principal?: string | null; + } + /** + * Response for AddAclEntry. + */ + export interface Schema$AddAclEntryResponse { + /** + * The updated acl. + */ + acl?: Schema$Acl; + /** + * Whether the acl was created as a result of adding the acl entry. + */ + aclCreated?: boolean | null; + } /** * The request message for Operations.CancelOperation. */ @@ -195,6 +258,107 @@ export namespace managedkafka_v1 { */ updateTime?: string | null; } + /** + * The configuration of access to the Kafka Connect cluster. + */ + export interface Schema$ConnectAccessConfig { + /** + * Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka Connect cluster. Minimum of 1 network is required. Maximum 10 networks can be specified. + */ + networkConfigs?: Schema$ConnectNetworkConfig[]; + } + /** + * An Apache Kafka Connect cluster deployed in a location. + */ + export interface Schema$ConnectCluster { + /** + * Required. Capacity configuration for the Kafka Connect cluster. + */ + capacityConfig?: Schema$CapacityConfig; + /** + * Optional. Configurations for the worker that are overridden from the defaults. The key of the map is a Kafka Connect worker property name, for example: `exactly.once.source.support`. + */ + config?: {[key: string]: string} | null; + /** + * Output only. The time when the cluster was created. + */ + createTime?: string | null; + /** + * Required. Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform. + */ + gcpConfig?: Schema$ConnectGcpConfig; + /** + * Required. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\} + */ + kafkaCluster?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number\}/locations/{location\}/connectClusters/{connect_cluster_id\} + */ + name?: string | 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; + } + /** + * Configuration properties for a Kafka Connect cluster deployed to Google Cloud Platform. + */ + export interface Schema$ConnectGcpConfig { + /** + * Required. Access configuration for the Kafka Connect cluster. + */ + accessConfig?: Schema$ConnectAccessConfig; + /** + * Optional. Secrets to load into workers. Exact SecretVersions from Secret Manager must be provided -- aliases are not supported. Up to 32 secrets may be loaded into one cluster. Format: projects//secrets//versions/ + */ + secretPaths?: string[] | null; + } + /** + * The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka Connect cluster. + */ + export interface Schema$ConnectNetworkConfig { + /** + * Optional. Additional subnets may be specified. They may be in another region, but must be in the same VPC network. The Connect workers can communicate with network endpoints in either the primary or additional subnets. + */ + additionalSubnets?: string[] | null; + /** + * Optional. Additional DNS domain names from the subnet's network to be made visible to the Connect Cluster. When using MirrorMaker2, it's necessary to add the bootstrap address's dns domain name of the target cluster to make it visible to the connector. For example: my-kafka-cluster.us-central1.managedkafka.my-project.cloud.goog + */ + dnsDomainNames?: string[] | null; + /** + * Required. VPC subnet to make available to the Kafka Connect cluster. Structured like: projects/{project\}/regions/{region\}/subnetworks/{subnet_id\} It is used to create a Private Service Connect (PSC) interface for the Kafka Connect workers. It must be located in the same region as the Kafka Connect cluster. The CIDR range of the subnet must be within the IPv4 address ranges for private networks, as specified in RFC 1918. The primary subnet CIDR range must have a minimum size of /22 (1024 addresses). + */ + primarySubnet?: string | null; + } + /** + * A Kafka Connect connector in a given ConnectCluster. + */ + export interface Schema$Connector { + /** + * Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`. + */ + configs?: {[key: string]: string} | null; + /** + * Identifier. The name of the connector. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connect_cluster\}/connectors/{connector\} + */ + name?: string | null; + /** + * Output only. The current state of the connector. + */ + state?: string | null; + /** + * Optional. Restarts the individual tasks of a Connector. + */ + taskRestartPolicy?: Schema$TaskRetryPolicy; + } /** * A Kafka consumer group in a given cluster. */ @@ -247,6 +411,19 @@ export namespace managedkafka_v1 { */ kmsKey?: string | null; } + /** + * Response for ListAcls. + */ + export interface Schema$ListAclsResponse { + /** + * The list of acls in the requested parent. The order of the acls is unspecified. + */ + acls?: Schema$Acl[]; + /** + * 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; + } /** * Response for ListClusters. */ @@ -264,6 +441,36 @@ export namespace managedkafka_v1 { */ unreachable?: string[] | null; } + /** + * Response for ListConnectClusters. + */ + export interface Schema$ListConnectClustersResponse { + /** + * The list of Connect clusters in the requested parent. + */ + connectClusters?: Schema$ConnectCluster[]; + /** + * 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 ListConnectors. + */ + export interface Schema$ListConnectorsResponse { + /** + * The list of connectors in the requested parent. + */ + connectors?: Schema$Connector[]; + /** + * 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; + } /** * Response for ListConsumerGroups. */ @@ -408,6 +615,14 @@ export namespace managedkafka_v1 { */ verb?: string | null; } + /** + * Request for PauseConnector. + */ + export interface Schema$PauseConnectorRequest {} + /** + * Response for PauseConnector. + */ + export interface Schema$PauseConnectorResponse {} /** * Defines rebalancing behavior of a Kafka cluster. */ @@ -417,6 +632,35 @@ export namespace managedkafka_v1 { */ mode?: string | null; } + /** + * Response for RemoveAclEntry. + */ + export interface Schema$RemoveAclEntryResponse { + /** + * The updated acl. Returned if the removed acl entry was not the last entry in the acl. + */ + acl?: Schema$Acl; + /** + * Returned with value true if the removed acl entry was the last entry in the acl, resulting in acl deletion. + */ + aclDeleted?: boolean | null; + } + /** + * Request for RestartConnector. + */ + export interface Schema$RestartConnectorRequest {} + /** + * Response for RestartConnector. + */ + export interface Schema$RestartConnectorResponse {} + /** + * Request for ResumeConnector. + */ + export interface Schema$ResumeConnectorRequest {} + /** + * Response for ResumeConnector. + */ + export interface Schema$ResumeConnectorResponse {} /** * 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). */ @@ -434,6 +678,27 @@ export namespace managedkafka_v1 { */ message?: string | null; } + /** + * Request for StopConnector. + */ + export interface Schema$StopConnectorRequest {} + /** + * Response for StopConnector. + */ + export interface Schema$StopConnectorResponse {} + /** + * Task Retry Policy is implemented on a best-effort basis. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 30 minutes respectively. + */ + export interface Schema$TaskRetryPolicy { + /** + * Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay. + */ + maximumBackoff?: string | null; + /** + * Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay. + */ + minimumBackoff?: string | null; + } /** * A Kafka topic in a given cluster. */ @@ -468,10 +733,14 @@ export namespace managedkafka_v1 { export class Resource$Projects$Locations { context: APIRequestContext; clusters: Resource$Projects$Locations$Clusters; + connectClusters: Resource$Projects$Locations$Connectclusters; operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; this.clusters = new Resource$Projects$Locations$Clusters(this.context); + this.connectClusters = new Resource$Projects$Locations$Connectclusters( + this.context + ); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -665,6 +934,10 @@ export namespace managedkafka_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -685,10 +958,12 @@ export namespace managedkafka_v1 { export class Resource$Projects$Locations$Clusters { context: APIRequestContext; + acls: Resource$Projects$Locations$Clusters$Acls; consumerGroups: Resource$Projects$Locations$Clusters$Consumergroups; topics: Resource$Projects$Locations$Clusters$Topics; constructor(context: APIRequestContext) { this.context = context; + this.acls = new Resource$Projects$Locations$Clusters$Acls(this.context); this.consumerGroups = new Resource$Projects$Locations$Clusters$Consumergroups(this.context); this.topics = new Resource$Projects$Locations$Clusters$Topics( @@ -1215,65 +1490,70 @@ export namespace managedkafka_v1 { requestBody?: Schema$Cluster; } - export class Resource$Projects$Locations$Clusters$Consumergroups { + export class Resource$Projects$Locations$Clusters$Acls { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes a single consumer group. + * Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + addAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, + addAclEntry( + params?: Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, + ): GaxiosPromise; + addAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, - callback: BodyResponseCallback + addAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + addAclEntry( + callback: BodyResponseCallback + ): void; + addAclEntry( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry + | 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$Clusters$Consumergroups$Delete; + {}) as Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete; + {} as Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry; options = {}; } @@ -1286,80 +1566,82 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+acl}:addAclEntry').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['acl'], + pathParams: ['acl'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the properties of a single consumer group. + * Creates a new acl in the given project, location, and 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$Consumergroups$Get, + create( + params: Params$Resource$Projects$Locations$Clusters$Acls$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, + create( + params?: Params$Resource$Projects$Locations$Clusters$Acls$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Clusters$Acls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Clusters$Acls$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Clusters$Acls$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Consumergroups$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clusters$Acls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clusters$Consumergroups$Get; + {}) as Params$Resource$Projects$Locations$Clusters$Acls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$Get; + params = {} as Params$Resource$Projects$Locations$Clusters$Acls$Create; options = {}; } @@ -1372,87 +1654,249 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/acls').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 the consumer groups in a given cluster. + * Deletes an acl. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + delete( + params: Params$Resource$Projects$Locations$Clusters$Acls$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, + delete( + params?: Params$Resource$Projects$Locations$Clusters$Acls$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Clusters$Acls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, - options: + delete( + params: Params$Resource$Projects$Locations$Clusters$Acls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Acls$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Acls$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Acls$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Acls$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 acl. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Acls$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Clusters$Acls$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Clusters$Acls$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Acls$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Acls$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Acls$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Acls$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Acls$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 acls 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$Acls$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Clusters$Acls$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Clusters$Acls$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Clusters$Acls$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Clusters$Acls$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Consumergroups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clusters$Acls$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$Clusters$Consumergroups$List; + {}) as Params$Resource$Projects$Locations$Clusters$Acls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$List; + params = {} as Params$Resource$Projects$Locations$Clusters$Acls$List; options = {}; } @@ -1465,10 +1909,7 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/consumerGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+parent}/acls').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -1480,17 +1921,17 @@ export namespace managedkafka_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the properties of a single consumer group. + * Updates the properties of a single acl. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1498,50 +1939,49 @@ export namespace managedkafka_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + params: Params$Resource$Projects$Locations$Clusters$Acls$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + params?: Params$Resource$Projects$Locations$Clusters$Acls$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + params: Params$Resource$Projects$Locations$Clusters$Acls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Clusters$Acls$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Clusters$Acls$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Clusters$Acls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch; + {}) as Params$Resource$Projects$Locations$Clusters$Acls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch; + params = {} as Params$Resource$Projects$Locations$Clusters$Acls$Patch; options = {}; } @@ -1566,121 +2006,2058 @@ export namespace managedkafka_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$Clusters$Consumergroups$Delete - extends StandardParameters { /** - * Required. The name of the consumer group to delete. `projects/{project\}/locations/{location\}/clusters/{cluster\}/consumerGroups/{consumerGroup\}`. + * Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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; + removeAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry, + options: StreamMethodOptions + ): GaxiosPromise; + removeAclEntry( + params?: Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry, + options?: MethodOptions + ): GaxiosPromise; + removeAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeAclEntry( + params: Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry, + callback: BodyResponseCallback + ): void; + removeAclEntry( + callback: BodyResponseCallback + ): void; + removeAclEntry( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+acl}:removeAclEntry').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['acl'], + pathParams: ['acl'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Projects$Locations$Clusters$Consumergroups$Get + + export interface Params$Resource$Projects$Locations$Clusters$Acls$Addaclentry extends StandardParameters { /** - * Required. The name of the consumer group whose configuration to return. `projects/{project\}/locations/{location\}/clusters/{cluster\}/consumerGroups/{consumerGroup\}`. + * Required. The name of the acl to add the acl entry to. Structured like: `projects/{project\}/locations/{location\}/clusters/{cluster\}/acls/{acl_id\}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details. */ - name?: string; + acl?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AclEntry; } - export interface Params$Resource$Projects$Locations$Clusters$Consumergroups$List + export interface Params$Resource$Projects$Locations$Clusters$Acls$Create 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. + * Required. The ID to use for the acl, which will become the final component of the acl's name. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name\}` `consumerGroup/{resource_name\}` `transactionalId/{resource_name\}` For acls on all resources that match a prefix: `topicPrefixed/{resource_name\}` `consumerGroupPrefixed/{resource_name\}` `transactionalIdPrefixed/{resource_name\}` For acls on all resources of a given type (i.e. the wildcard literal "*"): `allTopics` (represents `topic/x`) `allConsumerGroups` (represents `consumerGroup/x`) `allTransactionalIds` (represents `transactionalId/x`) + */ + aclId?: string; + /** + * Required. The parent cluster in which to create the acl. Structured like `projects/{project\}/locations/{location\}/clusters/{cluster\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Acl; + } + export interface Params$Resource$Projects$Locations$Clusters$Acls$Delete + extends StandardParameters { + /** + * Required. The name of the acl to delete. Structured like: `projects/{project\}/locations/{location\}/clusters/{cluster\}/acls/{acl_id\}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Acls$Get + extends StandardParameters { + /** + * Required. The name of the acl to return. Structured like: `projects/{project\}/locations/{location\}/clusters/{cluster\}/acls/{acl_id\}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Acls$List + extends StandardParameters { + /** + * Optional. The maximum number of acls to return. The service may return fewer than this value. If unset or zero, all acls 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. + * Optional. A page token, received from a previous `ListAcls` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAcls` 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\}`. + * Required. The parent cluster whose acls are to be listed. Structured like `projects/{project\}/locations/{location\}/clusters/{cluster\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch + export interface Params$Resource$Projects$Locations$Clusters$Acls$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\} + * Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/acls/{acl_id\} The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name\}` `consumerGroup/{resource_name\}` `transactionalId/{resource_name\}` For acls on all resources that match a prefix: `topicPrefixed/{resource_name\}` `consumerGroupPrefixed/{resource_name\}` `transactionalIdPrefixed/{resource_name\}` For acls on all resources of a given type (i.e. the wildcard literal "*"): `allTopics` (represents `topic/x`) `allConsumerGroups` (represents `consumerGroup/x`) `allTransactionalIds` (represents `transactionalId/x`) */ 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. + * Optional. Field mask is used to specify the fields to be overwritten in the Acl 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. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$ConsumerGroup; + requestBody?: Schema$Acl; } + export interface Params$Resource$Projects$Locations$Clusters$Acls$Removeaclentry + extends StandardParameters { + /** + * Required. The name of the acl to remove the acl entry from. Structured like: `projects/{project\}/locations/{location\}/clusters/{cluster\}/acls/{acl_id\}`. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details. + */ + acl?: string; - export class Resource$Projects$Locations$Clusters$Topics { + /** + * Request body metadata + */ + requestBody?: Schema$AclEntry; + } + + export class Resource$Projects$Locations$Clusters$Consumergroups { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new topic in a given project and location. + * 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$Connectclusters { + context: APIRequestContext; + connectors: Resource$Projects$Locations$Connectclusters$Connectors; + constructor(context: APIRequestContext) { + this.context = context; + this.connectors = + new Resource$Projects$Locations$Connectclusters$Connectors( + this.context + ); + } + + /** + * Creates a new Kafka Connect 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$Connectclusters$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Connectclusters$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Connectclusters$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Connectclusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Connectclusters$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$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}/connectClusters').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 Connect 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$Connectclusters$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Connectclusters$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Connectclusters$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Connectclusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Connectclusters$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$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 Kafka Connect 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$Connectclusters$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Connectclusters$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Connectclusters$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Connectclusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Connectclusters$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connectclusters$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 Kafka Connect 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$Connectclusters$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Connectclusters$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Connectclusters$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Connectclusters$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Connectclusters$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connectclusters$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}/connectClusters').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 Kafka Connect 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$Connectclusters$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Connectclusters$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Connectclusters$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Connectclusters$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Connectclusters$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Connectclusters$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$Connectclusters$Create + extends StandardParameters { + /** + * Required. The ID to use for the Connect 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`. + */ + connectClusterId?: string; + /** + * Required. The parent project/location in which to create the Kafka Connect 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$ConnectCluster; + } + export interface Params$Resource$Projects$Locations$Connectclusters$Delete + extends StandardParameters { + /** + * Required. The name of the Kafka Connect cluster to delete. Structured like `projects/{project\}/locations/{location\}/connectClusters/{connect_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; + } + export interface Params$Resource$Projects$Locations$Connectclusters$Get + extends StandardParameters { + /** + * Required. The name of the Kafka Connect cluster whose configuration to return. Structured like `projects/{project\}/locations/{location\}/connectClusters/{connect_cluster_id\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Connectclusters$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 Connect 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 `ListConnectClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectClusters` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent project/location whose Connect clusters are to be listed. Structured like `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Connectclusters$Patch + extends StandardParameters { + /** + * Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number\}/locations/{location\}/connectClusters/{connect_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$ConnectCluster; + } + + export class Resource$Projects$Locations$Connectclusters$Connectors { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new connector in a given Connect 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. + */ + create( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$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}/connectors').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 connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Connectclusters$Connectors$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$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 connector. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Connectclusters$Connectors$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$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 connectors in a given Connect 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$Connectclusters$Connectors$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connectclusters$Connectors$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$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}/connectors').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 connector. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + patch( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Clusters$Topics$Create, + patch( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Clusters$Topics$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Clusters$Topics$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Clusters$Topics$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Topics$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clusters$Topics$Create; + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clusters$Topics$Create; + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$Patch; options = {}; } @@ -1693,83 +4070,85 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/topics').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); } } /** - * Deletes a single topic. + * Pauses the connector and its tasks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + pause( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Clusters$Topics$Delete, + pause( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Clusters$Topics$Delete, + ): GaxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Clusters$Topics$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Clusters$Topics$Delete, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + pause(callback: BodyResponseCallback): void; + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Topics$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause + | 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$Clusters$Topics$Delete; + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clusters$Topics$Delete; + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause; options = {}; } @@ -1782,8 +4161,8 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -1794,67 +4173,75 @@ export namespace managedkafka_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns the properties of a single topic. + * Restarts the connector. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + restart( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Clusters$Topics$Get, + restart( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Clusters$Topics$Get, + ): GaxiosPromise; + restart( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Clusters$Topics$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + restart( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Clusters$Topics$Get, - callback: BodyResponseCallback + restart( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + restart( + callback: BodyResponseCallback + ): void; + restart( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Topics$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart + | 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$Clusters$Topics$Get; + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Clusters$Topics$Get; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart; options = {}; } @@ -1867,8 +4254,11 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:restart').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -1879,70 +4269,75 @@ export namespace managedkafka_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the topics in a given cluster. + * Resumes the connector and its tasks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + resume( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Clusters$Topics$List, + resume( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Clusters$Topics$List, + ): GaxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Clusters$Topics$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Clusters$Topics$List, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + resume( + callback: BodyResponseCallback + ): void; + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Topics$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clusters$Topics$List; + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Clusters$Topics$List; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume; options = {}; } @@ -1955,82 +4350,85 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/topics').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the properties of a single topic. + * Stops the connector. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + stop( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Clusters$Topics$Patch, + stop( + params?: Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Clusters$Topics$Patch, + ): GaxiosPromise; + stop( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Clusters$Topics$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + stop( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Clusters$Topics$Patch, - callback: BodyResponseCallback + stop( + params: Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + stop(callback: BodyResponseCallback): void; + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Topics$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop + | 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$Clusters$Topics$Patch; + {}) as Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Clusters$Topics$Patch; + params = + {} as Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop; options = {}; } @@ -2043,8 +4441,8 @@ export namespace managedkafka_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -2055,76 +4453,124 @@ export namespace managedkafka_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$Clusters$Topics$Create + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$Create extends StandardParameters { /** - * Required. The parent cluster in which to create the topic. Structured like `projects/{project\}/locations/{location\}/clusters/{cluster\}`. + * Required. The ID to use for the connector, which will become the final component of the connector'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-connector-id`. */ - parent?: string; + connectorId?: 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`. + * Required. The parent Connect cluster in which to create the connector. Structured like `projects/{project\}/locations/{location\}/connectClusters/{connect_cluster_id\}`. */ - topicId?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$Topic; + requestBody?: Schema$Connector; } - export interface Params$Resource$Projects$Locations$Clusters$Topics$Delete + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$Delete extends StandardParameters { /** - * Required. The name of the topic to delete. `projects/{project\}/locations/{location\}/clusters/{cluster\}/topics/{topic\}`. + * Required. The name of the connector to delete. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connectCluster\}/connectors/{connector\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Topics$Get + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$Get extends StandardParameters { /** - * Required. The name of the topic whose configuration to return. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/topics/{topic\}. + * Required. The name of the connector whose configuration to return. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connectCluster\}/connectors/{connector\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Topics$List + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$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. + * Optional. The maximum number of connectors 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 `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. + * Optional. A page token, received from a previous `ListConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectors` 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\}`. + * Required. The parent Connect cluster whose connectors are to be listed. Structured like `projects/{project\}/locations/{location\}/connectClusters/{connect_cluster_id\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Topics$Patch + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$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\} + * Identifier. The name of the connector. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connect_cluster\}/connectors/{connector\} */ 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. + * 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$Topic; + requestBody?: Schema$Connector; + } + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$Pause + extends StandardParameters { + /** + * Required. The name of the connector to pause. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connectCluster\}/connectors/{connector\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PauseConnectorRequest; + } + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$Restart + extends StandardParameters { + /** + * Required. The name of the connector to restart. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connectCluster\}/connectors/{connector\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestartConnectorRequest; + } + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$Resume + extends StandardParameters { + /** + * Required. The name of the connector to pause. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connectCluster\}/connectors/{connector\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResumeConnectorRequest; + } + export interface Params$Resource$Projects$Locations$Connectclusters$Connectors$Stop + extends StandardParameters { + /** + * Required. The name of the connector to stop. Structured like: projects/{project\}/locations/{location\}/connectClusters/{connectCluster\}/connectors/{connector\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StopConnectorRequest; } export class Resource$Projects$Locations$Operations { diff --git a/src/apis/meet/v2.ts b/src/apis/meet/v2.ts index e9e8b4b387a..aefe9fe7389 100644 --- a/src/apis/meet/v2.ts +++ b/src/apis/meet/v2.ts @@ -144,6 +144,23 @@ export namespace meet_v2 { */ displayName?: string | null; } + /** + * Configuration related to meeting artifacts potentially generated by this meeting space. + */ + export interface Schema$ArtifactConfig { + /** + * Configuration for recording. + */ + recordingConfig?: Schema$RecordingConfig; + /** + * Configuration for auto-smart-notes. + */ + smartNotesConfig?: Schema$SmartNotesConfig; + /** + * Configuration for auto-transcript. + */ + transcriptionConfig?: Schema$TranscriptionConfig; + } /** * Single instance of a meeting held in a space. */ @@ -285,6 +302,27 @@ export namespace meet_v2 { */ transcripts?: Schema$Transcript[]; } + /** + * Defines restrictions for features when the meeting is moderated. + */ + export interface Schema$ModerationRestrictions { + /** + * Defines who has permission to send chat messages in the meeting space. + */ + chatRestriction?: string | null; + /** + * Defines whether to restrict the default role assigned to users as viewer. + */ + defaultJoinAsViewerType?: string | null; + /** + * Defines who has permission to share their screen in the meeting space. + */ + presentRestriction?: string | null; + /** + * Defines who has permission to send reactions in the meeting space. + */ + reactionRestriction?: string | null; + } /** * User who attended or is attending a conference. */ @@ -365,6 +403,15 @@ export namespace meet_v2 { */ state?: string | null; } + /** + * Configuration related to recording in a meeting space. + */ + export interface Schema$RecordingConfig { + /** + * Defines whether a meeting space is automatically recorded when someone with the privilege to record joins the meeting. + */ + autoRecordingGeneration?: string | null; + } /** * A signed-in user can be: a) An individual joining from a personal computer, mobile device, or through companion mode. b) A robot account used by conference room devices. */ @@ -378,6 +425,15 @@ export namespace meet_v2 { */ user?: string | null; } + /** + * Configuration related to smart notes in a meeting space. For more information about smart notes, see ["Take notes for me" in Google Meet](https://support.google.com/meet/answer/14754931). + */ + export interface Schema$SmartNotesConfig { + /** + * Defines whether to automatically generate a summary and recap of the meeting for all invitees in the organization when someone with the privilege to enable smart notes joins the meeting. + */ + autoSmartNotesGeneration?: string | null; + } /** * Virtual place where conferences are held. Only one active conference can be held in one space at any given time. */ @@ -399,7 +455,7 @@ export namespace meet_v2 { */ meetingUri?: string | null; /** - * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string | null; } @@ -411,10 +467,26 @@ export namespace meet_v2 { * Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. */ accessType?: string | null; + /** + * Configuration pertaining to the auto-generated artifacts that the meeting supports. + */ + artifactConfig?: Schema$ArtifactConfig; + /** + * Whether attendance report is enabled for the meeting space. + */ + attendanceReportGenerationType?: string | null; /** * Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL */ entryPointAccess?: string | null; + /** + * The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies. + */ + moderation?: string | null; + /** + * When moderation.ON, these restrictions go into effect for the meeting. When moderation.OFF, will be reset to default ModerationRestrictions. + */ + moderationRestrictions?: Schema$ModerationRestrictions; } /** * Metadata for a transcript generated from a conference. It refers to the ASR (Automatic Speech Recognition) result of user's speech during the conference. @@ -470,6 +542,15 @@ export namespace meet_v2 { */ text?: string | null; } + /** + * Configuration related to transcription in a meeting space. + */ + export interface Schema$TranscriptionConfig { + /** + * Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting. + */ + autoTranscriptionGeneration?: string | null; + } export class Resource$Conferencerecords { context: APIRequestContext; @@ -1558,7 +1639,7 @@ export namespace meet_v2 { } /** - * Gets a `TranscriptEntry` resource by entry ID. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation. + * Gets a `TranscriptEntry` resource by entry ID. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1644,7 +1725,7 @@ export namespace meet_v2 { } /** - * Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation. + * Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order. Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1856,7 +1937,7 @@ export namespace meet_v2 { } /** - * Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference). + * Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#end-active-conference). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1944,7 +2025,7 @@ export namespace meet_v2 { } /** - * Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space). + * Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#get-meeting-space). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2028,7 +2109,7 @@ export namespace meet_v2 { } /** - * Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space). + * Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#update-meeting-space). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2121,7 +2202,7 @@ export namespace meet_v2 { export interface Params$Resource$Spaces$Endactiveconference extends StandardParameters { /** - * Required. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + * Required. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; @@ -2132,13 +2213,13 @@ export namespace meet_v2 { } export interface Params$Resource$Spaces$Get extends StandardParameters { /** - * Required. Resource name of the space. Format: `spaces/{space\}` or `spaces/{meetingCode\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode\}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + * Required. Resource name of the space. Format: `spaces/{space\}` or `spaces/{meetingCode\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode\}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; } export interface Params$Resource$Spaces$Patch extends StandardParameters { /** - * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; /** diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index 7358e31c0ed..bb8a180989b 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -135,14 +135,23 @@ export namespace merchantapi_accounts_v1beta { */ acceptedBy?: string | null; /** - * The accepted [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService). + * The accepted termsOfService. */ termsOfService?: string | null; /** - * When set, it states that the accepted [TermsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required [TermsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) is found in the [Required](Required) message. + * When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. */ validUntil?: Schema$Date; } + /** + * Response message for the `AcceptTermsOfService` method. + */ + export interface Schema$AcceptTermsOfServiceResponse { + /** + * The agreement state after accepting the ToS. + */ + termsOfServiceAgreementState?: Schema$TermsOfServiceAgreementState; + } /** * The `Account` message represents a merchant's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a multi-client account (MCA) structure. In an MCA setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. */ @@ -172,7 +181,7 @@ export namespace merchantapi_accounts_v1beta { */ testAccount?: boolean | null; /** - * Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. + * Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. The `version` field is not supported, won't be set in responses and will be silently ignored if specified in requests. */ timeZone?: Schema$TimeZone; } @@ -209,6 +218,76 @@ export namespace merchantapi_accounts_v1beta { */ title?: string | null; } + /** + * `AccountManagement` payload. + */ + export interface Schema$AccountManagement {} + /** + * The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). + */ + export interface Schema$AccountRelationship { + /** + * Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems. + */ + accountIdAlias?: string | null; + /** + * Identifier. The resource name of the account relationship. + */ + name?: string | null; + /** + * Immutable. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). + */ + provider?: string | null; + /** + * Output only. The human-readable display name of the provider account. + */ + providerDisplayName?: string | null; + } + /** + * The `AccountService` message represents a specific service that a provider account offers to a merchant account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the merchant and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. + */ + export interface Schema$AccountService { + /** + * Service type for account aggregation. This enables the provider, which is a Multi-Client Account (MCA), to manage multiple sub-accounts (client accounts). Through this service, the MCA provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many merchant accounts. + */ + accountAggregation?: Schema$AccountAggregation; + /** + * Service type for account management. Enables the provider to perform administrative actions on the merchant's account, such as configuring account settings, managing users, or updating business information. + */ + accountManagement?: Schema$AccountManagement; + /** + * Service type for managing advertising campaigns. Grants the provider access to create and manage the merchant's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance. + */ + campaignsManagement?: Schema$CampaignsManagement; + /** + * Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. + */ + externalAccountId?: string | null; + /** + * Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + */ + handshake?: Schema$Handshake; + /** + * Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable. + */ + mutability?: string | null; + /** + * Identifier. The resource name of the account service. + */ + name?: string | null; + /** + * Service type for managing products. This allows the provider to handle product data on behalf of the merchant, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the merchant's product information up-to-date across platforms. + */ + productsManagement?: Schema$ProductsManagement; + /** + * Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). + */ + provider?: string | null; + /** + * Output only. The human-readable display name of the provider account. + */ + providerDisplayName?: string | null; + } /** * Additional instructions to add account services during creation of the account. */ @@ -260,6 +339,10 @@ export namespace merchantapi_accounts_v1beta { */ userId?: string | null; } + /** + * Request to approve an account service. + */ + export interface Schema$ApproveAccountServiceRequest {} /** * Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. */ @@ -416,6 +499,10 @@ export namespace merchantapi_accounts_v1beta { */ phoneVerificationState?: string | null; } + /** + * `CampaignManagement` payload. + */ + export interface Schema$CampaignsManagement {} /** * A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only. */ @@ -648,6 +735,19 @@ export namespace merchantapi_accounts_v1beta { */ geotargetCriteriaIds?: string[] | null; } + /** + * The current status of establishing of the service. (for example, pending approval or approved). + */ + export interface Schema$Handshake { + /** + * Output only. The most recent account to modify the account service's `approval_status`. + */ + actor?: string | null; + /** + * Output only. The approval state of this handshake. + */ + approvalState?: string | null; + } /** * A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. */ @@ -768,6 +868,32 @@ export namespace merchantapi_accounts_v1beta { */ nextPageToken?: string | null; } + /** + * Response after trying to list account relationships. + */ + export interface Schema$ListAccountRelationshipsResponse { + /** + * The account relationships that match your filter. + */ + accountRelationships?: Schema$AccountRelationship[]; + /** + * A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages. + */ + nextPageToken?: string | null; + } + /** + * Response after trying to list account services. + */ + export interface Schema$ListAccountServicesResponse { + /** + * The account services that match your filter. + */ + accountServices?: Schema$AccountService[]; + /** + * A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages. + */ + nextPageToken?: string | null; + } /** * Response message for the `ListAccounts` method. */ @@ -939,6 +1065,10 @@ export namespace merchantapi_accounts_v1beta { * Optional. 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. */ restockingFee?: Schema$RestockingFee; + /** + * The field specifies the return label source. This field is required when return method is BY_MAIL. + */ + returnLabelSource?: string | null; /** * 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. */ @@ -991,15 +1121,15 @@ export namespace merchantapi_accounts_v1beta { type?: 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 + * 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 or 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$PostalAddress { /** - * 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -1007,7 +1137,7 @@ export namespace merchantapi_accounts_v1beta { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -1015,7 +1145,7 @@ export namespace merchantapi_accounts_v1beta { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -1031,11 +1161,11 @@ export namespace merchantapi_accounts_v1beta { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } @@ -1099,6 +1229,10 @@ export namespace merchantapi_accounts_v1beta { */ reportingContext?: string | null; } + /** + * `ProductsManagement` payload. + */ + export interface Schema$ProductsManagement {} /** * The message that the merchant will receive to notify about product status change event */ @@ -1165,6 +1299,19 @@ export namespace merchantapi_accounts_v1beta { */ unmetRequirements?: Schema$Requirement[]; } + /** + * Request to propose an account service. + */ + export interface Schema$ProposeAccountServiceRequest { + /** + * Required. The account service to propose. + */ + accountService?: Schema$AccountService; + /** + * Required. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). + */ + provider?: string | null; + } /** * Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap. */ @@ -1223,16 +1370,20 @@ export namespace merchantapi_accounts_v1beta { */ shippingEligible?: boolean | null; } + /** + * Request to reject an account service. + */ + export interface Schema$RejectAccountServiceRequest {} /** * Describes the terms of service which are required to be accepted. */ export interface Schema$Required { /** - * The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted. + * The `TermsOfService` that need to be accepted. */ termsOfService?: string | null; /** - * Full URL to the terms of service file. This field is the same as [TermsOfService.file_uri](TermsOfService.file_uri), it is added here for convenience only. + * Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. */ tosFileUri?: string | null; } @@ -1319,7 +1470,7 @@ export namespace merchantapi_accounts_v1beta { */ active?: boolean | null; /** - * The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. + * Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. */ currencyCode?: string | null; /** @@ -1360,7 +1511,7 @@ export namespace merchantapi_accounts_v1beta { storeConfig?: Schema$StoreConfig; } /** - * The merchant account's [shipping setting](https://support.google.com/merchants/answer/6069284). + * The merchant account's [shipping settings](https://support.google.com/merchants/answer/6069284). */ export interface Schema$ShippingSettings { /** @@ -1368,7 +1519,7 @@ export namespace merchantapi_accounts_v1beta { */ etag?: string | null; /** - * Identifier. The resource name of the shipping setting. Format: `accounts/{account\}/shippingSetting` + * Identifier. The resource name of the shipping settings. Format: `accounts/{account\}/shippingSettings` */ name?: string | null; /** @@ -1449,7 +1600,7 @@ export namespace merchantapi_accounts_v1beta { rows?: Schema$Row[]; } /** - * The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services (see https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`. + * The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`. */ export interface Schema$TermsOfService { /** @@ -1474,7 +1625,7 @@ export namespace merchantapi_accounts_v1beta { regionCode?: string | null; } /** - * This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service: [accepted](TermsOfServiceAggrementState.accepted) will be populated, otherwise it will be empty * If the merchant must sign a terms of service: [required](TermsOfServiceAggrementState.required) will be populated, otherwise it will be empty. Note that both [required](TermsOfServiceAggrementState.required) and [accepted](TermsOfServiceAggrementState.accepted) can be present. In this case the `accepted` terms of services will have an expiration date set in the [valid_until](Accepted.valid_until) field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as [tos_file_uri](Accepted.tos_file_uri). The actual acceptance of the terms of service is done by calling accept on the [TermsOfService](TermsOfService) resource. + * This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the merchant must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. */ export interface Schema$TermsOfServiceAgreementState { /** @@ -1668,6 +1819,7 @@ export namespace merchantapi_accounts_v1beta { export class Resource$Accounts { context: APIRequestContext; autofeedSettings: Resource$Accounts$Autofeedsettings; + automaticImprovements: Resource$Accounts$Automaticimprovements; businessIdentity: Resource$Accounts$Businessidentity; businessInfo: Resource$Accounts$Businessinfo; emailPreferences: Resource$Accounts$Emailpreferences; @@ -1676,6 +1828,8 @@ export namespace merchantapi_accounts_v1beta { onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies; programs: Resource$Accounts$Programs; regions: Resource$Accounts$Regions; + relationships: Resource$Accounts$Relationships; + services: Resource$Accounts$Services; shippingSettings: Resource$Accounts$Shippingsettings; termsOfServiceAgreementStates: Resource$Accounts$Termsofserviceagreementstates; users: Resource$Accounts$Users; @@ -1684,6 +1838,9 @@ export namespace merchantapi_accounts_v1beta { this.autofeedSettings = new Resource$Accounts$Autofeedsettings( this.context ); + this.automaticImprovements = new Resource$Accounts$Automaticimprovements( + this.context + ); this.businessIdentity = new Resource$Accounts$Businessidentity( this.context ); @@ -1698,6 +1855,8 @@ export namespace merchantapi_accounts_v1beta { ); this.programs = new Resource$Accounts$Programs(this.context); this.regions = new Resource$Accounts$Regions(this.context); + this.relationships = new Resource$Accounts$Relationships(this.context); + this.services = new Resource$Accounts$Services(this.context); this.shippingSettings = new Resource$Accounts$Shippingsettings( this.context ); @@ -1707,7 +1866,7 @@ export namespace merchantapi_accounts_v1beta { } /** - * Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. + * Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1967,101 +2126,6 @@ export namespace merchantapi_accounts_v1beta { } } - /** - * 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. * @@ -2334,210 +2398,92 @@ export namespace merchantapi_accounts_v1beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Accounts$Createandconfigure + extends StandardParameters { /** - * Updates the automatic improvements of an account. + * Request body metadata + */ + requestBody?: Schema$CreateAndConfigureAccountRequest; + } + export interface Params$Resource$Accounts$Delete extends StandardParameters { + /** + * Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers. + */ + force?: boolean; + /** + * Required. The name of the account to delete. Format: `accounts/{account\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Required. The name of the account to retrieve. Format: `accounts/{account\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$List extends StandardParameters { + /** + * Optional. Returns only accounts that match the [filter](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; + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Accounts$Listsubaccounts + extends StandardParameters { + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The aggregation service provider. Format: `accounts/{providerId\}` + */ + provider?: string; + } + export interface Params$Resource$Accounts$Patch extends StandardParameters { + /** + * Identifier. The resource name of the account. Format: `accounts/{account\}` + */ + name?: string; + /** + * Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_name` - `adult_content` - `language_code` - `time_zone` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + + export class Resource$Accounts$Autofeedsettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the autofeed settings 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 - extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$CreateAndConfigureAccountRequest; - } - export interface Params$Resource$Accounts$Delete extends StandardParameters { - /** - * Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers. - */ - force?: boolean; - /** - * Required. The name of the account to delete. Format: `accounts/{account\}` - */ - name?: string; - } - export interface Params$Resource$Accounts$Get extends StandardParameters { - /** - * Required. The name of the account to retrieve. Format: `accounts/{account\}` - */ - name?: string; - } - export interface Params$Resource$Accounts$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](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; - /** - * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. - */ - pageToken?: string; - } - export interface Params$Resource$Accounts$Listsubaccounts - extends StandardParameters { - /** - * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The aggregation service provider. Format: `providers/{providerId\}` - */ - provider?: string; - } - export interface Params$Resource$Accounts$Patch extends StandardParameters { - /** - * Identifier. The resource name of the account. Format: `accounts/{account\}` - */ - name?: string; - /** - * Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_name` - `adult_content` - `language_code` - `time_zone` - */ - updateMask?: string; - - /** - * Request body metadata - */ - 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; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Retrieves the autofeed settings 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. - */ - getAutofeedSettings( - params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, + getAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, options: StreamMethodOptions ): GaxiosPromise; getAutofeedSettings( @@ -2735,67 +2681,72 @@ export namespace merchantapi_accounts_v1beta { requestBody?: Schema$AutofeedSettings; } - export class Resource$Accounts$Businessidentity { + export class Resource$Accounts$Automaticimprovements { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves the business identity of an account. + * 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. */ - getBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + getAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, options: StreamMethodOptions ): GaxiosPromise; - getBusinessIdentity( - params?: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + getAutomaticImprovements( + params?: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, options?: MethodOptions - ): GaxiosPromise; - getBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + ): GaxiosPromise; + getAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, - callback: BodyResponseCallback + getAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, + callback: BodyResponseCallback ): void; - getBusinessIdentity( - callback: BodyResponseCallback + getAutomaticImprovements( + callback: BodyResponseCallback ): void; - getBusinessIdentity( + getAutomaticImprovements( paramsOrCallback?: - | Params$Resource$Accounts$Businessidentity$Getbusinessidentity - | BodyResponseCallback + | Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; + {}) as Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; + {} as Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements; options = {}; } @@ -2823,44 +2774,262 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the business identity of an account. Executing this method requires admin access. + * 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. */ - updateBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + updateAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, options: StreamMethodOptions ): GaxiosPromise; - updateBusinessIdentity( - params?: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + updateAutomaticImprovements( + params?: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, options?: MethodOptions - ): GaxiosPromise; - updateBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + ): GaxiosPromise; + updateAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateBusinessIdentity( - params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, - callback: BodyResponseCallback + updateAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAutomaticImprovements( + params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, + callback: BodyResponseCallback + ): void; + updateAutomaticImprovements( + callback: BodyResponseCallback + ): void; + updateAutomaticImprovements( + paramsOrCallback?: + | Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Automaticimprovements$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$Automaticimprovements$Getautomaticimprovements + extends StandardParameters { + /** + * Required. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements` + */ + name?: string; + } + export interface Params$Resource$Accounts$Automaticimprovements$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$Businessidentity { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the business identity of an account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + options: StreamMethodOptions + ): GaxiosPromise; + getBusinessIdentity( + params?: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + options?: MethodOptions + ): GaxiosPromise; + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + callback: BodyResponseCallback + ): void; + getBusinessIdentity( + callback: BodyResponseCallback + ): void; + getBusinessIdentity( + paramsOrCallback?: + | Params$Resource$Accounts$Businessidentity$Getbusinessidentity + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; + 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); + } + } + + /** + * Updates the business identity of an account. Executing this method requires admin access. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + options: StreamMethodOptions + ): GaxiosPromise; + updateBusinessIdentity( + params?: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + options?: MethodOptions + ): GaxiosPromise; + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + callback: BodyResponseCallback ): void; updateBusinessIdentity( callback: BodyResponseCallback @@ -3784,7 +3953,7 @@ export namespace merchantapi_accounts_v1beta { } /** - * Lists all account issues of a Merchant Center account. + * Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.issues.list` for each sub-account individually. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3886,7 +4055,7 @@ export namespace merchantapi_accounts_v1beta { */ languageCode?: string; /** - * Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100 + * Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100 */ pageSize?: number; /** @@ -4513,82 +4682,919 @@ export namespace merchantapi_accounts_v1beta { /** * Required. The name of the program to retrieve. Format: `accounts/{account\}/programs/{program\}` */ - name?: string; + name?: string; + } + export interface Params$Resource$Accounts$Programs$List + extends StandardParameters { + /** + * Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A continuation token, received from a previous `ListPrograms` call. Provide this to retrieve the next page. + */ + pageToken?: string; + /** + * Required. The name of the account for which to retrieve all programs. Format: `accounts/{account\}` + */ + parent?: string; + } + + export class Resource$Accounts$Regions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a region definition in your Merchant Center account. Executing this method requires admin access. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Accounts$Regions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Accounts$Regions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Accounts$Regions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Regions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Regions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$Create; + 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/{+parent}/regions').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 region definition from your Merchant Center account. Executing this method requires admin access. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Accounts$Regions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Accounts$Regions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Accounts$Regions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Regions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Regions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a region defined in your Merchant Center account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Regions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Regions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Regions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Regions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Regions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$Get; + 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 the regions in your Merchant Center account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Accounts$Regions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Accounts$Regions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Regions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Regions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Regions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$List; + 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/{+parent}/regions').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 region definition in your Merchant Center account. Executing this method requires admin access. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Accounts$Regions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Accounts$Regions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Regions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Regions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Regions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accounts$Regions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Regions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Regions$Patch; + 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$Regions$Create + extends StandardParameters { + /** + * Required. The account to create a region for. Format: `accounts/{account\}` + */ + parent?: string; + /** + * Required. The identifier for the region, unique over all regions of the same account. + */ + regionId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Region; + } + export interface Params$Resource$Accounts$Regions$Delete + extends StandardParameters { + /** + * Required. The name of the region to delete. Format: `accounts/{account\}/regions/{region\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$Regions$Get + extends StandardParameters { + /** + * Required. The name of the region to retrieve. Format: `accounts/{account\}/regions/{region\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$Regions$List + extends StandardParameters { + /** + * Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The account to list regions for. Format: `accounts/{account\}` + */ + parent?: string; + } + export interface Params$Resource$Accounts$Regions$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the region. Format: `accounts/{account\}/regions/{region\}` + */ + name?: string; + /** + * Optional. The comma-separated field mask indicating the fields to update. Example: `"displayName,postalCodeArea.regionCode"`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Region; + } + + export class Resource$Accounts$Relationships { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieve an account relationship. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Relationships$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Relationships$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Relationships$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Relationships$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Relationships$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Relationships$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Relationships$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Relationships$Get; + 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); + } + } + + /** + * List account relationships for the specified account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Accounts$Relationships$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Accounts$Relationships$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Relationships$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Relationships$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Relationships$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Relationships$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Relationships$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Relationships$List; + 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/{+parent}/relationships').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 account relationship. Executing this method requires admin access. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Accounts$Relationships$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Accounts$Relationships$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Relationships$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Relationships$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Relationships$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accounts$Relationships$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Relationships$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Relationships$Patch; + 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$Relationships$Get + extends StandardParameters { + /** + * Required. The resource name of the account relationship to get. + */ + name?: string; + } + export interface Params$Resource$Accounts$Relationships$List + extends StandardParameters { + /** + * Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`. + */ + pageSize?: number; + /** + * Optional. The token returned by the previous `list` request. + */ + pageToken?: string; + /** + * Required. The parent account of the account relationship to filter by. + */ + parent?: string; } - export interface Params$Resource$Accounts$Programs$List + export interface Params$Resource$Accounts$Relationships$Patch extends StandardParameters { /** - * Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Identifier. The resource name of the account relationship. */ - pageSize?: number; + name?: string; /** - * Optional. A continuation token, received from a previous `ListPrograms` call. Provide this to retrieve the next page. + * Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_id_alias` */ - pageToken?: string; + updateMask?: string; + /** - * Required. The name of the account for which to retrieve all programs. Format: `accounts/{account\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$AccountRelationship; } - export class Resource$Accounts$Regions { + export class Resource$Accounts$Services { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a region definition in your Merchant Center account. Executing this method requires admin access. + * Approve an account service proposal. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Accounts$Regions$Create, + approve( + params: Params$Resource$Accounts$Services$Approve, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Accounts$Regions$Create, + approve( + params?: Params$Resource$Accounts$Services$Approve, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Accounts$Regions$Create, + ): GaxiosPromise; + approve( + params: Params$Resource$Accounts$Services$Approve, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Accounts$Regions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + approve( + params: Params$Resource$Accounts$Services$Approve, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Accounts$Regions$Create, - callback: BodyResponseCallback + approve( + params: Params$Resource$Accounts$Services$Approve, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + approve(callback: BodyResponseCallback): void; + approve( paramsOrCallback?: - | Params$Resource$Accounts$Regions$Create - | BodyResponseCallback + | Params$Resource$Accounts$Services$Approve + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Regions$Create; + {}) as Params$Resource$Accounts$Services$Approve; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Regions$Create; + params = {} as Params$Resource$Accounts$Services$Approve; options = {}; } @@ -4601,7 +5607,7 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+parent}/regions').replace( + url: (rootUrl + '/accounts/v1beta/{+name}:approve').replace( /([^:]\/)\/+/g, '$1' ), @@ -4611,72 +5617,72 @@ export namespace merchantapi_accounts_v1beta { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a region definition from your Merchant Center account. Executing this method requires admin access. + * Retrieve an account 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$Accounts$Regions$Delete, + get( + params: Params$Resource$Accounts$Services$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Accounts$Regions$Delete, + get( + params?: Params$Resource$Accounts$Services$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Accounts$Regions$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Services$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Accounts$Regions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Accounts$Services$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Accounts$Regions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Accounts$Services$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Accounts$Regions$Delete - | BodyResponseCallback + | Params$Resource$Accounts$Services$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$Accounts$Regions$Delete; + {}) as Params$Resource$Accounts$Services$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Regions$Delete; + params = {} as Params$Resource$Accounts$Services$Get; options = {}; } @@ -4693,7 +5699,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -4704,67 +5710,74 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a region defined in your Merchant Center account. + * List account services for the specified accounts. Supports filtering. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Accounts$Regions$Get, + list( + params: Params$Resource$Accounts$Services$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Accounts$Regions$Get, + list( + params?: Params$Resource$Accounts$Services$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accounts$Regions$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Services$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Accounts$Regions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Accounts$Services$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Accounts$Regions$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Accounts$Services$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Accounts$Regions$Get - | BodyResponseCallback + | Params$Resource$Accounts$Services$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$Accounts$Regions$Get; + {}) as Params$Resource$Accounts$Services$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Regions$Get; + params = {} as Params$Resource$Accounts$Services$List; options = {}; } @@ -4777,7 +5790,7 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( + url: (rootUrl + '/accounts/v1beta/{+parent}/services').replace( /([^:]\/)\/+/g, '$1' ), @@ -4787,75 +5800,72 @@ export namespace merchantapi_accounts_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the regions in your Merchant Center account. + * Propose an account 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$Accounts$Regions$List, + propose( + params: Params$Resource$Accounts$Services$Propose, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Accounts$Regions$List, + propose( + params?: Params$Resource$Accounts$Services$Propose, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accounts$Regions$List, + ): GaxiosPromise; + propose( + params: Params$Resource$Accounts$Services$Propose, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Accounts$Regions$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + propose( + params: Params$Resource$Accounts$Services$Propose, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Accounts$Regions$List, - callback: BodyResponseCallback + propose( + params: Params$Resource$Accounts$Services$Propose, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + propose(callback: BodyResponseCallback): void; + propose( paramsOrCallback?: - | Params$Resource$Accounts$Regions$List - | BodyResponseCallback + | Params$Resource$Accounts$Services$Propose + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Regions$List; + {}) as Params$Resource$Accounts$Services$Propose; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Regions$List; + params = {} as Params$Resource$Accounts$Services$Propose; options = {}; } @@ -4868,11 +5878,10 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+parent}/regions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/accounts/v1beta/{+parent}/services:propose' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -4883,67 +5892,67 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a region definition in your Merchant Center account. Executing this method requires admin access. + * Reject an account service (both proposed and approve services can be rejected). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Accounts$Regions$Patch, + reject( + params: Params$Resource$Accounts$Services$Reject, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Accounts$Regions$Patch, + reject( + params?: Params$Resource$Accounts$Services$Reject, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Regions$Patch, + ): GaxiosPromise; + reject( + params: Params$Resource$Accounts$Services$Reject, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Regions$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + reject( + params: Params$Resource$Accounts$Services$Reject, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Regions$Patch, - callback: BodyResponseCallback + reject( + params: Params$Resource$Accounts$Services$Reject, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + reject(callback: BodyResponseCallback): void; + reject( paramsOrCallback?: - | Params$Resource$Accounts$Regions$Patch - | BodyResponseCallback + | Params$Resource$Accounts$Services$Reject + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Regions$Patch; + {}) as Params$Resource$Accounts$Services$Reject; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Regions$Patch; + params = {} as Params$Resource$Accounts$Services$Reject; options = {}; } @@ -4956,11 +5965,11 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( + url: (rootUrl + '/accounts/v1beta/{+name}:reject').replace( /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options @@ -4971,76 +5980,73 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Accounts$Regions$Create + export interface Params$Resource$Accounts$Services$Approve extends StandardParameters { /** - * Required. The account to create a region for. Format: `accounts/{account\}` - */ - parent?: string; - /** - * Required. The identifier for the region, unique over all regions of the same account. + * Required. The resource name of the account service to approve. */ - regionId?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$Region; - } - export interface Params$Resource$Accounts$Regions$Delete - extends StandardParameters { - /** - * Required. The name of the region to delete. Format: `accounts/{account\}/regions/{region\}` - */ - name?: string; + requestBody?: Schema$ApproveAccountServiceRequest; } - export interface Params$Resource$Accounts$Regions$Get + export interface Params$Resource$Accounts$Services$Get extends StandardParameters { /** - * Required. The name of the region to retrieve. Format: `accounts/{account\}/regions/{region\}` + * Required. The resource name of the account service to get. */ name?: string; } - export interface Params$Resource$Accounts$Regions$List + export interface Params$Resource$Accounts$Services$List extends StandardParameters { /** - * Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token. + * Optional. The token returned by the previous `list` request. */ pageToken?: string; /** - * Required. The account to list regions for. Format: `accounts/{account\}` + * Required. The parent account of the account service to filter by. */ parent?: string; } - export interface Params$Resource$Accounts$Regions$Patch + export interface Params$Resource$Accounts$Services$Propose extends StandardParameters { /** - * Identifier. The resource name of the region. Format: `accounts/{account\}/regions/{region\}` + * Required. The resource name of the parent account for the service. */ - name?: string; + parent?: string; + /** - * Optional. The comma-separated field mask indicating the fields to update. Example: `"displayName,postalCodeArea.regionCode"`. + * Request body metadata */ - updateMask?: string; + requestBody?: Schema$ProposeAccountServiceRequest; + } + export interface Params$Resource$Accounts$Services$Reject + extends StandardParameters { + /** + * Required. The resource name of the account service to reject. + */ + name?: string; /** * Request body metadata */ - requestBody?: Schema$Region; + requestBody?: Schema$RejectAccountServiceRequest; } export class Resource$Accounts$Shippingsettings { @@ -5231,14 +6237,14 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Shippingsettings$Getshippingsettings extends StandardParameters { /** - * Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsetting` + * Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsettings` */ name?: string; } export interface Params$Resource$Accounts$Shippingsettings$Insert extends StandardParameters { /** - * Required. The account where this product will be inserted. Format: accounts/{account\} + * Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: `accounts/{ACCOUNT_ID\}` */ parent?: string; @@ -5454,7 +6460,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Termsofserviceagreementstates$Get extends StandardParameters { /** - * Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}` + * Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementStates/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}` */ name?: string; } @@ -5999,7 +7005,7 @@ export namespace merchantapi_accounts_v1beta { accept( params?: Params$Resource$Termsofservice$Accept, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; accept( params: Params$Resource$Termsofservice$Accept, options: StreamMethodOptions | BodyResponseCallback, @@ -6007,28 +7013,35 @@ export namespace merchantapi_accounts_v1beta { ): void; accept( params: Params$Resource$Termsofservice$Accept, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; accept( params: Params$Resource$Termsofservice$Accept, - callback: BodyResponseCallback + callback: BodyResponseCallback + ): void; + accept( + callback: BodyResponseCallback ): void; - accept(callback: BodyResponseCallback): void; accept( paramsOrCallback?: | Params$Resource$Termsofservice$Accept - | 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$Termsofservice$Accept; let options = (optionsOrCallback || {}) as MethodOptions; @@ -6052,7 +7065,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -6063,12 +7076,14 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -6251,7 +7266,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Termsofservice$Accept extends StandardParameters { /** - * Required. The account for which to accept the ToS. + * Required. The account for which to accept the ToS. Format: `accounts/{account\}` */ account?: string; /** diff --git a/src/apis/merchantapi/conversions_v1beta.ts b/src/apis/merchantapi/conversions_v1beta.ts index 9fb5eae7bc8..c0d6229c366 100644 --- a/src/apis/merchantapi/conversions_v1beta.ts +++ b/src/apis/merchantapi/conversions_v1beta.ts @@ -129,9 +129,12 @@ export namespace merchantapi_conversions_v1beta { */ export interface Schema$AttributionSettings { /** - * Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. + * Required. Lookback window (in days) used for attribution in this source. Supported values are `7`, `30` & `40`. */ attributionLookbackWindowDays?: number | null; + /** + * Required. Attribution model. + */ attributionModel?: string | null; /** * Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. @@ -159,7 +162,7 @@ export namespace merchantapi_conversions_v1beta { */ merchantCenterDestination?: Schema$MerchantCenterDestination; /** - * Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: [a-z]{4\}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources. + * Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: `[a-z]{4\}:.+` The four characters before the colon represent the type of conversion source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: * `galk`: For GoogleAnalyticsLink sources. * `mcdn`: For MerchantCenterDestination sources. */ name?: string | null; /** @@ -168,7 +171,7 @@ export namespace merchantapi_conversions_v1beta { state?: string | null; } /** - * Message representing a types of conversion events + * Message representing the type of a conversion event. */ export interface Schema$ConversionType { /** @@ -219,7 +222,7 @@ export namespace merchantapi_conversions_v1beta { */ export interface Schema$MerchantCenterDestination { /** - * Required. Attribution settings being used for the Merchant Center Destination. + * Required. Attribution settings used for the Merchant Center Destination. */ attributionSettings?: Schema$AttributionSettings; /** @@ -231,7 +234,7 @@ export namespace merchantapi_conversions_v1beta { */ destination?: string | null; /** - * Required. Merchant-specified display name for the destination. This is the name that identifies the conversion source within the Merchant Center UI. Limited to 64 characters. + * Required. Merchant-specified display name for the destination. This is the name that identifies the conversion source within the Merchant Center UI. The maximum length is 64 characters. */ displayName?: string | null; } @@ -858,7 +861,7 @@ export namespace merchantapi_conversions_v1beta { export interface Params$Resource$Accounts$Conversionsources$Create extends StandardParameters { /** - * Required. The merchant account that will own the new conversion source. Format: accounts/{account\} + * Required. The merchant account that will own the new conversion source. Format: `accounts/{account\}` */ parent?: string; @@ -870,14 +873,14 @@ export namespace merchantapi_conversions_v1beta { export interface Params$Resource$Accounts$Conversionsources$Delete extends StandardParameters { /** - * Required. The name of the conversion source to be deleted. Format: accounts/{account\}/conversionSources/{conversion_source\} + * Required. The name of the conversion source to be deleted. Format: `accounts/{account\}/conversionSources/{conversion_source\}` */ name?: string; } export interface Params$Resource$Accounts$Conversionsources$Get extends StandardParameters { /** - * Required. The name of the conversion source to be fetched. Format: accounts/{account\}/conversionSources/{conversion_source\} + * Required. The name of the conversion source to be fetched. Format: `accounts/{account\}/conversionSources/{conversion_source\}` */ name?: string; } @@ -892,18 +895,18 @@ export namespace merchantapi_conversions_v1beta { */ pageToken?: string; /** - * Required. The merchant account who owns the collection of conversion sources. Format: accounts/{account\} + * Required. The merchant account who owns the collection of conversion sources. Format: `accounts/{account\}` */ parent?: string; /** - * Optional. Show deleted (archived) option. + * Optional. Show deleted (archived) conversion sources. By default, deleted conversion sources are not returned. */ showDeleted?: boolean; } export interface Params$Resource$Accounts$Conversionsources$Patch extends StandardParameters { /** - * Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: [a-z]{4\}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources. + * Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: `[a-z]{4\}:.+` The four characters before the colon represent the type of conversion source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: * `galk`: For GoogleAnalyticsLink sources. * `mcdn`: For MerchantCenterDestination sources. */ name?: string; /** @@ -919,7 +922,7 @@ export namespace merchantapi_conversions_v1beta { export interface Params$Resource$Accounts$Conversionsources$Undelete extends StandardParameters { /** - * Required. The name of the conversion source to be undeleted. Format: accounts/{account\}/conversionSources/{conversion_source\} + * Required. The name of the conversion source to be undeleted. Format: `accounts/{account\}/conversionSources/{conversion_source\}` */ name?: string; diff --git a/src/apis/merchantapi/datasources_v1beta.ts b/src/apis/merchantapi/datasources_v1beta.ts index ec19c21f6fd..b012d6ccc83 100644 --- a/src/apis/merchantapi/datasources_v1beta.ts +++ b/src/apis/merchantapi/datasources_v1beta.ts @@ -125,7 +125,7 @@ export namespace merchantapi_datasources_v1beta { } /** - * The [data source](https://support.google.com/merchants/answer/7439058) for the Merchant Center account. + * The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account. */ export interface Schema$DataSource { /** @@ -153,7 +153,7 @@ export namespace merchantapi_datasources_v1beta { */ merchantReviewDataSource?: Schema$MerchantReviewDataSource; /** - * Identifier. The name of the data source. Format: `{datasource.name=accounts/{account\}/dataSources/{datasource\}\}` + * Identifier. The name of the data source. Format: `accounts/{account\}/dataSources/{datasource\}` */ name?: string | null; /** @@ -1145,7 +1145,7 @@ export namespace merchantapi_datasources_v1beta { export interface Params$Resource$Accounts$Datasources$Patch extends StandardParameters { /** - * Identifier. The name of the data source. Format: `{datasource.name=accounts/{account\}/dataSources/{datasource\}\}` + * Identifier. The name of the data source. Format: `accounts/{account\}/dataSources/{datasource\}` */ name?: string; /** diff --git a/src/apis/merchantapi/inventories_v1beta.ts b/src/apis/merchantapi/inventories_v1beta.ts index 980bae82dfc..b5052778a26 100644 --- a/src/apis/merchantapi/inventories_v1beta.ts +++ b/src/apis/merchantapi/inventories_v1beta.ts @@ -321,7 +321,7 @@ export namespace merchantapi_inventories_v1beta { */ account?: string | null; /** - * Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/3061342) + * Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/6324448). */ availability?: string | null; /** diff --git a/src/apis/merchantapi/lfp_v1beta.ts b/src/apis/merchantapi/lfp_v1beta.ts index f6853563e0c..ad24cad94a5 100644 --- a/src/apis/merchantapi/lfp_v1beta.ts +++ b/src/apis/merchantapi/lfp_v1beta.ts @@ -124,10 +124,64 @@ export namespace merchantapi_lfp_v1beta { } } + /** + * Country-specific settings for the merchant. + */ + export interface Schema$CountrySettings { + /** + * True if this merchant has enabled free local listings in MC. + */ + freeLocalListingsEnabled?: boolean | null; + /** + * Output only. The verification state of this merchant's instock serving feature. + */ + instockServingVerificationState?: string | null; + /** + * Output only. The verification state of this merchant's inventory check. + */ + inventoryVerificationState?: string | null; + /** + * True if this merchant has enabled local inventory ads in MC. + */ + localInventoryAdsEnabled?: boolean | null; + /** + * Output only. The verification state of this merchant's pickup serving feature. + */ + pickupServingVerificationState?: string | null; + /** + * Output only. The product page type selected by this merchant. + */ + productPageType?: string | null; + /** + * Required. The [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml) for the country for which these settings are defined. + */ + regionCode?: string | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * The inventory statistics for a merchant. + */ + export interface Schema$InventoryStats { + /** + * Number of entries (understanding entry as a pair of product and store) that were built based on provided inventories/sales and submitted to Google. + */ + submittedEntries?: string | null; + /** + * Number of submitted in stock entries. + */ + submittedInStockEntries?: string | null; + /** + * Number of products from provided inventories/sales that were created from matches to existing online products provided by the merchant or to the Google catalog. + */ + submittedProducts?: string | null; + /** + * Number of entries that were built based on provided inventories/sales and couldn't be submitted to Google due to errors like missing product. + */ + unsubmittedEntries?: string | null; + } /** * Local Inventory for the merchant. */ @@ -189,6 +243,31 @@ export namespace merchantapi_lfp_v1beta { */ targetAccount?: string | null; } + /** + * The LFP state of a merchant. + */ + export interface Schema$LfpMerchantState { + /** + * Country-specific settings for the merchant. + */ + countrySettings?: Schema$CountrySettings[]; + /** + * The inventory statistics for the merchant. + */ + inventoryStats?: Schema$InventoryStats; + /** + * Number of [GBPs](https://www.google.com/business/) this merchant has access to. + */ + linkedGbps?: string | null; + /** + * Identifier. The name of the `LfpMerchantState` resource. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}` + */ + name?: string | null; + /** + * Output only. The state per store from the specified merchant. + */ + storeStates?: Schema$LfpStoreState[]; + } /** * A sale for the merchant. */ @@ -291,6 +370,23 @@ export namespace merchantapi_lfp_v1beta { */ websiteUri?: string | null; } + /** + * The state of a specific merchant's store. + */ + export interface Schema$LfpStoreState { + /** + * Output only. The store matching state. + */ + matchingState?: string | null; + /** + * The hint of why the matching has failed (only set if matching_state is FAILED). + */ + matchingStateHint?: string | null; + /** + * Required. Immutable. The identifier of this store. + */ + storeCode?: string | null; + } /** * Response message for the ListLfpStores method. */ @@ -383,11 +479,15 @@ export namespace merchantapi_lfp_v1beta { export class Resource$Accounts { context: APIRequestContext; lfpInventories: Resource$Accounts$Lfpinventories; + lfpMerchantStates: Resource$Accounts$Lfpmerchantstates; lfpSales: Resource$Accounts$Lfpsales; lfpStores: Resource$Accounts$Lfpstores; constructor(context: APIRequestContext) { this.context = context; this.lfpInventories = new Resource$Accounts$Lfpinventories(this.context); + this.lfpMerchantStates = new Resource$Accounts$Lfpmerchantstates( + this.context + ); this.lfpSales = new Resource$Accounts$Lfpsales(this.context); this.lfpStores = new Resource$Accounts$Lfpstores(this.context); } @@ -500,6 +600,109 @@ export namespace merchantapi_lfp_v1beta { requestBody?: Schema$LfpInventory; } + export class Resource$Accounts$Lfpmerchantstates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the LFP state of a merchant + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Lfpmerchantstates$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Lfpmerchantstates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Lfpmerchantstates$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Lfpmerchantstates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Lfpmerchantstates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Lfpmerchantstates$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Lfpmerchantstates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Lfpmerchantstates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/lfp/v1beta/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Lfpmerchantstates$Get + extends StandardParameters { + /** + * Required. The name of the state to retrieve. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}` + */ + name?: string; + } + export class Resource$Accounts$Lfpsales { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/merchantapi/products_v1beta.ts b/src/apis/merchantapi/products_v1beta.ts index f543c16cf83..93cfa2c7339 100644 --- a/src/apis/merchantapi/products_v1beta.ts +++ b/src/apis/merchantapi/products_v1beta.ts @@ -501,6 +501,23 @@ export namespace merchantapi_products_v1beta { */ virtualModelLink?: string | null; } + /** + * Information regarding Automated Discounts. + */ + export interface Schema$AutomatedDiscounts { + /** + * The current sale price for products with a price optimized using Google Automated Discounts (GAD). Absent if the information about the GAD_price of the product is not available. + */ + gadPrice?: Schema$Price; + /** + * The price prior to the application of the first price reduction. Absent if the information about the prior price of the product is not available. + */ + priorPrice?: Schema$Price; + /** + * The price prior to the application of consecutive price reductions. Absent if the information about the prior price of the product is not available. + */ + priorPriceProgressive?: Schema$Price; + } /** * Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. */ @@ -766,13 +783,17 @@ export namespace merchantapi_products_v1beta { currencyCode?: string | null; } /** - * The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account and in Shopping ads and other surfaces across Google. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. + * The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. */ export interface Schema$Product { /** * Output only. A list of product attributes. */ attributes?: Schema$Attributes; + /** + * Output only. The automated discounts information for the product. + */ + automatedDiscounts?: Schema$AutomatedDiscounts; /** * Output only. The [channel](https://support.google.com/merchants/answer/7361332) of the product. */ @@ -794,7 +815,7 @@ export namespace merchantapi_products_v1beta { */ feedLabel?: string | null; /** - * The name of the product. Format: `"{product.name=accounts/{account\}/products/{product\}\}"` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/products/online~en~US~sku123" + * The name of the product. Format: `accounts/{account\}/products/{product\}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123` */ name?: string | null; /** @@ -862,7 +883,7 @@ export namespace merchantapi_products_v1beta { value?: number | null; } /** - * This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112). + * This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. */ export interface Schema$ProductInput { /** @@ -878,7 +899,7 @@ export namespace merchantapi_products_v1beta { */ contentLanguage?: string | null; /** - * 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 additional attributes used for Buy on Google. 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. 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[]; /** @@ -886,7 +907,7 @@ export namespace merchantapi_products_v1beta { */ feedLabel?: string | null; /** - * Identifier. The name of the product input. Format: `"{productinput.name=accounts/{account\}/productInputs/{productinput\}\}"` where the last section `productinput` consists of 4 parts: channel~content_language~feed_label~offer_id example for product input name is "accounts/123/productInputs/online~en~US~sku123" + * Identifier. The name of the product input. Format: `accounts/{account\}/productInputs/{productinput\}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123` */ name?: string | null; /** @@ -894,11 +915,11 @@ export namespace merchantapi_products_v1beta { */ offerId?: string | null; /** - * Output only. The name of the processed product. Format: `"{product.name=accounts/{account\}/products/{product\}\}"` + * Output only. The name of the processed product. Format: `accounts/{account\}/products/{product\}` */ product?: string | null; /** - * Optional. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. If the operation is prevented, the aborted exception will be thrown. + * Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. */ versionNumber?: string | null; } @@ -1460,7 +1481,7 @@ export namespace merchantapi_products_v1beta { */ dataSource?: string; /** - * Required. The name of the product input resource to delete. Format: accounts/{account\}/productInputs/{product\} where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/productInputs/online~en~US~sku123" + * Required. The name of the product input resource to delete. Format: `accounts/{account\}/productInputs/{product\}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/productInputs/online~en~US~sku123`. */ name?: string; } @@ -1471,7 +1492,7 @@ export namespace merchantapi_products_v1beta { */ dataSource?: string; /** - * Required. The account where this product will be inserted. Format: accounts/{account\} + * Required. The account where this product will be inserted. Format: `accounts/{account\}` */ parent?: string; @@ -1487,7 +1508,7 @@ export namespace merchantapi_products_v1beta { */ dataSource?: string; /** - * Identifier. The name of the product input. Format: `"{productinput.name=accounts/{account\}/productInputs/{productinput\}\}"` where the last section `productinput` consists of 4 parts: channel~content_language~feed_label~offer_id example for product input name is "accounts/123/productInputs/online~en~US~sku123" + * Identifier. The name of the product input. Format: `accounts/{account\}/productInputs/{productinput\}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123` */ name?: string; /** @@ -1596,7 +1617,7 @@ export namespace merchantapi_products_v1beta { } /** - * Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. + * Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1692,7 +1713,7 @@ export namespace merchantapi_products_v1beta { export interface Params$Resource$Accounts$Products$Get extends StandardParameters { /** - * Required. The name of the product to retrieve. Format: `accounts/{account\}/products/{product\}` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/products/online~en~US~sku123" + * Required. The name of the product to retrieve. Format: `accounts/{account\}/products/{product\}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123` */ name?: string; } @@ -1707,7 +1728,7 @@ export namespace merchantapi_products_v1beta { */ pageToken?: string; /** - * Required. The account to list processed products for. Format: accounts/{account\} + * Required. The account to list processed products for. Format: `accounts/{account\}` */ parent?: string; } diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index f180f9d292e..090430afe94 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -1551,6 +1551,10 @@ export namespace metastore_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index 9592dfaaac9..f7917a73106 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -492,6 +492,10 @@ export namespace metastore_v1alpha { * Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number\}/locations/{location_id\}/keyRings/{key_ring_id\}/cryptoKeys/{crypto_key_id\}. */ kmsKey?: string | null; + /** + * Optional. The list of fully qualified customer provided Cloud KMS key names for the multi-regional service. Each key must be in the following format:projects/{project_number\}/locations/{location_id\}/keyRings/{key_ring_id\}/cryptoKeys/{crypto_key_id\}. + */ + kmsKeys?: string[] | null; } /** * Error details in public error message for DataprocMetastore.QueryMetadata. @@ -1653,6 +1657,10 @@ export namespace metastore_v1alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index 5351779a6c7..fd9239c48cb 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -492,6 +492,10 @@ export namespace metastore_v1beta { * Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number\}/locations/{location_id\}/keyRings/{key_ring_id\}/cryptoKeys/{crypto_key_id\}. */ kmsKey?: string | null; + /** + * Optional. The list of fully qualified customer provided Cloud KMS key names for the multi-regional service. Each key must be in the following format:projects/{project_number\}/locations/{location_id\}/keyRings/{key_ring_id\}/cryptoKeys/{crypto_key_id\}. + */ + kmsKeys?: string[] | null; } /** * Error details in public error message for DataprocMetastore.QueryMetadata. @@ -1653,6 +1657,10 @@ export namespace metastore_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/migrationcenter/v1.ts b/src/apis/migrationcenter/v1.ts index 4c32f41b098..ac7723edcd1 100644 --- a/src/apis/migrationcenter/v1.ts +++ b/src/apis/migrationcenter/v1.ts @@ -153,6 +153,10 @@ export namespace migrationcenter_v1 { * Optional. The aggregation will be performed on assets that match the provided filter. */ filter?: string | null; + /** + * Optional. When this value is set to 'true,' the response will include all assets, including those that are hidden. + */ + showHidden?: boolean | null; } /** * A response to a request to aggregated assets values. @@ -287,6 +291,18 @@ export namespace migrationcenter_v1 { * Output only. Asset information specific for logical databases. */ databaseDetails?: Schema$DatabaseDetails; + /** + * Optional. Indicates if the asset is hidden. + */ + hidden?: boolean | null; + /** + * Optional. An optional reason for marking this asset as hidden. + */ + hideReason?: string | null; + /** + * Output only. The timestamp when the asset was marked as hidden. + */ + hideTime?: string | null; /** * Output only. The list of insights associated with the asset. */ @@ -3824,6 +3840,10 @@ export namespace migrationcenter_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -4680,6 +4700,10 @@ export namespace migrationcenter_v1 { * Required. Parent value for `ListAssetsRequest`. */ parent?: string; + /** + * Optional. When this value is set to 'true,' the response will include all assets, including those that are hidden. + */ + showHidden?: boolean; /** * View of the assets. Defaults to BASIC. */ diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 5e19f278974..6d37e9ef53c 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -1386,6 +1386,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. Identifier. Full name of this discovery client. */ name?: string | null; + /** + * Output only. The recommended versions of the discovery client. + */ + recommendedVersions?: Schema$DiscoveryClientDiscoveryClientRecommendedVersion[]; /** * Required. Service account used by the discovery client for various operation. */ @@ -1415,6 +1419,19 @@ export namespace migrationcenter_v1alpha1 { */ version?: string | null; } + /** + * Discovery client recommended version. + */ + export interface Schema$DiscoveryClientDiscoveryClientRecommendedVersion { + /** + * Output only. The URI of the discovery client version. + */ + uri?: string | null; + /** + * Output only. The version of the discovery client. + */ + version?: string | null; + } /** * Single disk entry. */ @@ -4907,6 +4924,10 @@ export namespace migrationcenter_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 703e65f2330..de8513574b8 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -1294,6 +1294,10 @@ export namespace monitoring_v3 { * The unit in which all time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. If different time_series have different units (for example, because they come from different metric types, or a unit is absent), then unit will be "{not_a_unit\}". */ unit?: string | null; + /** + * Cloud regions that were unreachable which may have caused incomplete data to be returned. + */ + unreachable?: string[] | null; } /** * The protocol for the ListUptimeCheckConfigs response. @@ -2374,6 +2378,10 @@ export namespace monitoring_v3 { * The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check. */ contentMatchers?: Schema$ContentMatcher[]; + /** + * Whether the check is disabled or not. + */ + disabled?: boolean | null; /** * A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. */ diff --git a/src/apis/mybusinessaccountmanagement/v1.ts b/src/apis/mybusinessaccountmanagement/v1.ts index 87c88d5406e..e841496076a 100644 --- a/src/apis/mybusinessaccountmanagement/v1.ts +++ b/src/apis/mybusinessaccountmanagement/v1.ts @@ -291,15 +291,15 @@ export namespace mybusinessaccountmanagement_v1 { registeredDomain?: 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 + * 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 or 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$PostalAddress { /** - * 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -307,7 +307,7 @@ export namespace mybusinessaccountmanagement_v1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -315,7 +315,7 @@ export namespace mybusinessaccountmanagement_v1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -331,11 +331,11 @@ export namespace mybusinessaccountmanagement_v1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/mybusinessbusinessinformation/v1.ts b/src/apis/mybusinessbusinessinformation/v1.ts index 7f8909ae8fd..2ad52283b25 100644 --- a/src/apis/mybusinessbusinessinformation/v1.ts +++ b/src/apis/mybusinessbusinessinformation/v1.ts @@ -709,15 +709,15 @@ export namespace mybusinessbusinessinformation_v1 { placeInfos?: Schema$PlaceInfo[]; } /** - * 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 + * 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 or 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$PostalAddress { /** - * 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -725,7 +725,7 @@ export namespace mybusinessbusinessinformation_v1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -733,7 +733,7 @@ export namespace mybusinessbusinessinformation_v1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -749,11 +749,11 @@ export namespace mybusinessbusinessinformation_v1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/mybusinessverifications/v1.ts b/src/apis/mybusinessverifications/v1.ts index f6d9b532e7f..fae06d5b99c 100644 --- a/src/apis/mybusinessverifications/v1.ts +++ b/src/apis/mybusinessverifications/v1.ts @@ -221,15 +221,15 @@ export namespace mybusinessverifications_v1 { verifications?: Schema$Verification[]; } /** - * 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 + * 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 or 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$PostalAddress { /** - * 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -237,7 +237,7 @@ export namespace mybusinessverifications_v1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -245,7 +245,7 @@ export namespace mybusinessverifications_v1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -261,11 +261,11 @@ export namespace mybusinessverifications_v1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/netapp/v1.ts b/src/apis/netapp/v1.ts index ecc4fffffbe..3e56bab4aee 100644 --- a/src/apis/netapp/v1.ts +++ b/src/apis/netapp/v1.ts @@ -221,6 +221,10 @@ export namespace netapp_v1 { * A NetApp Backup. */ export interface Schema$Backup { + /** + * Output only. Region in which backup is stored. Format: `projects/{project_id\}/locations/{location\}` + */ + backupRegion?: string | null; /** * Output only. Type of backup, manually created or created by a backup policy. */ @@ -265,6 +269,10 @@ export namespace netapp_v1 { * Output only. The backup state. */ state?: string | null; + /** + * Output only. Region of the volume from which the backup was created. Format: `projects/{project_id\}/locations/{location\}` + */ + volumeRegion?: string | null; /** * Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big. */ @@ -340,6 +348,14 @@ export namespace netapp_v1 { * A NetApp BackupVault. */ export interface Schema$BackupVault { + /** + * Optional. Region where the backups are stored. Format: `projects/{project_id\}/locations/{location\}` + */ + backupRegion?: string | null; + /** + * Optional. Type of backup vault to be created. Default is IN_REGION. + */ + backupVaultType?: string | null; /** * Output only. Create time of the backup vault. */ @@ -348,6 +364,10 @@ export namespace netapp_v1 { * Description of the backup vault. */ description?: string | null; + /** + * Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}` + */ + destinationBackupVault?: string | null; /** * Resource labels to represent user provided metadata. */ @@ -356,6 +376,14 @@ export namespace netapp_v1 { * Identifier. The resource name of the backup vault. Format: `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}`. */ name?: string | null; + /** + * Output only. Name of the Backup vault created in source region. Format: `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}` + */ + sourceBackupVault?: string | null; + /** + * Output only. Region in which the backup vault is created. Format: `projects/{project_id\}/locations/{location\}` + */ + sourceRegion?: string | null; /** * Output only. The backup vault state. */ @@ -1290,7 +1318,7 @@ export namespace netapp_v1 { */ export interface Schema$TieringPolicy { /** - * Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31. + * Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. */ coolingThresholdDays?: number | null; /** @@ -1772,6 +1800,10 @@ export namespace netapp_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/netapp/v1beta1.ts b/src/apis/netapp/v1beta1.ts index 5581996c388..5ab6b6535f2 100644 --- a/src/apis/netapp/v1beta1.ts +++ b/src/apis/netapp/v1beta1.ts @@ -221,6 +221,10 @@ export namespace netapp_v1beta1 { * A NetApp Backup. */ export interface Schema$Backup { + /** + * Output only. Region in which backup is stored. Format: `projects/{project_id\}/locations/{location\}` + */ + backupRegion?: string | null; /** * Output only. Type of backup, manually created or created by a backup policy. */ @@ -265,6 +269,10 @@ export namespace netapp_v1beta1 { * Output only. The backup state. */ state?: string | null; + /** + * Output only. Region of the volume from which the backup was created. Format: `projects/{project_id\}/locations/{location\}` + */ + volumeRegion?: string | null; /** * Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big. */ @@ -340,6 +348,14 @@ export namespace netapp_v1beta1 { * A NetApp BackupVault. */ export interface Schema$BackupVault { + /** + * Optional. Region where the backups are stored. Format: `projects/{project_id\}/locations/{location\}` + */ + backupRegion?: string | null; + /** + * Optional. Type of backup vault to be created. Default is IN_REGION. + */ + backupVaultType?: string | null; /** * Output only. Create time of the backup vault. */ @@ -348,6 +364,10 @@ export namespace netapp_v1beta1 { * Description of the backup vault. */ description?: string | null; + /** + * Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}` + */ + destinationBackupVault?: string | null; /** * Resource labels to represent user provided metadata. */ @@ -356,6 +376,14 @@ export namespace netapp_v1beta1 { * Identifier. The resource name of the backup vault. Format: `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}`. */ name?: string | null; + /** + * Output only. Name of the Backup vault created in source region. Format: `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}` + */ + sourceBackupVault?: string | null; + /** + * Output only. Region in which the backup vault is created. Format: `projects/{project_id\}/locations/{location\}` + */ + sourceRegion?: string | null; /** * Output only. The backup vault state. */ @@ -1204,6 +1232,10 @@ export namespace netapp_v1beta1 { * Output only. Create time of the storage pool */ createTime?: string | null; + /** + * Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false + */ + customPerformanceEnabled?: boolean | null; /** * Optional. Description of the storage pool */ @@ -1264,6 +1296,14 @@ export namespace netapp_v1beta1 { * Output only. State details of the storage pool */ stateDetails?: string | null; + /** + * Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps + */ + totalIops?: string | null; + /** + * Optional. Custom Performance Total Throughput of the pool (in MiB/s) + */ + totalThroughputMibps?: string | null; /** * Output only. Allocated size of all volumes in GIB in the storage pool */ @@ -1290,7 +1330,7 @@ export namespace netapp_v1beta1 { */ export interface Schema$TieringPolicy { /** - * Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 7-183. Default is 31. + * Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. */ coolingThresholdDays?: number | null; /** @@ -1772,6 +1812,10 @@ export namespace netapp_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index b243dcaf427..1d3a4c6484f 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -579,6 +579,14 @@ export namespace networkconnectivity_v1 { * A description of this resource. */ description?: string | null; + /** + * Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks + */ + excludeCidrRanges?: string[] | null; + /** + * Optional. Immutable ranges cannot have their fields modified, except for labels and description. + */ + immutable?: boolean | null; /** * The IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly. */ @@ -670,6 +678,10 @@ export namespace networkconnectivity_v1 { * Output only. The URI of the Producer VPC. */ producerNetwork?: string | null; + /** + * Output only. The proposed exclude export IP ranges waiting for hub administration's approval. + */ + proposedExcludeExportRanges?: string[] | null; /** * Optional. The proposed include export IP ranges waiting for hub administration's approval. */ @@ -713,9 +725,13 @@ export namespace networkconnectivity_v1 { */ includeExportRanges?: string[] | null; /** - * Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. 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. + * 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 through 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; + /** + * Output only. The proposed exclude export IP ranges waiting for hub administration's approval. + */ + proposedExcludeExportRanges?: string[] | null; /** * Optional. The proposed include export IP ranges waiting for hub administration's approval. */ @@ -2186,6 +2202,10 @@ export namespace networkconnectivity_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/networkconnectivity/v1alpha1.ts b/src/apis/networkconnectivity/v1alpha1.ts index 3359322fd55..eff859e5c6e 100644 --- a/src/apis/networkconnectivity/v1alpha1.ts +++ b/src/apis/networkconnectivity/v1alpha1.ts @@ -124,6 +124,19 @@ export namespace networkconnectivity_v1alpha1 { } } + /** + * Range auto-allocation options, to be optionally used when CIDR block is not explicitly set. + */ + export interface Schema$AllocationOptions { + /** + * Optional. Allocation strategy Not setting this field when the allocation is requested means an implementation defined strategy is used. + */ + allocationStrategy?: string | null; + /** + * Optional. This field must be set only when allocation_strategy is set to RANDOM_FIRST_N_AVAILABLE. The value should be the maximum expected parallelism of range creation requests issued to the same space of peered netwroks. + */ + firstAvailableRangesLookupSize?: number | 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. */ @@ -292,6 +305,10 @@ export namespace networkconnectivity_v1alpha1 { * The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it. */ export interface Schema$InternalRange { + /** + * Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length). + */ + allocationOptions?: Schema$AllocationOptions; /** * Time when the internal range was created. */ @@ -300,6 +317,10 @@ export namespace networkconnectivity_v1alpha1 { * A description of this resource. */ description?: string | null; + /** + * Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks + */ + excludeCidrRanges?: string[] | null; /** * Optional. Immutable ranges cannot have their fields modified, except for labels and description. */ @@ -821,6 +842,10 @@ export namespace networkconnectivity_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index c3c9290ea9b..6280acb0d78 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -316,7 +316,7 @@ export namespace networkmanagement_v1 { */ export interface Schema$ConnectivityTest { /** - * Whether the test should skip firewall checking. If not provided, we assume false. + * Whether the analysis should skip firewall checking. Default value is false. */ bypassFirewallChecks?: boolean | null; /** @@ -328,7 +328,7 @@ export namespace networkmanagement_v1 { */ description?: string | null; /** - * Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. + * Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, URI of a supported endpoint, project ID, or VPC network to identify the destination location. Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination that you don't intend to test. */ destination?: Schema$Endpoint; /** @@ -368,7 +368,7 @@ export namespace networkmanagement_v1 { */ roundTrip?: boolean | null; /** - * Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. + * Required. Source specification of the Connectivity Test. You can use a combination of source IP address, URI of a supported endpoint, project ID, or VPC network to identify the source location. Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don't intend to test. */ source?: Schema$Endpoint; /** @@ -469,15 +469,15 @@ export namespace networkmanagement_v1 { */ export interface Schema$Endpoint { /** - * An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions). + * An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions). Applicable only to source endpoint. */ appEngineVersion?: Schema$AppEngineVersionEndpoint; /** - * A [Cloud Function](https://cloud.google.com/functions). + * A [Cloud Function](https://cloud.google.com/functions). Applicable only to source endpoint. */ cloudFunction?: Schema$CloudFunctionEndpoint; /** - * A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) + * A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. */ cloudRunRevision?: Schema$CloudRunRevisionEndpoint; /** @@ -485,7 +485,7 @@ export namespace networkmanagement_v1 { */ cloudSqlInstance?: string | null; /** - * A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Format: projects/{project\}/global/forwardingRules/{id\} or projects/{project\}/regions/{region\}/forwardingRules/{id\} + * A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: projects/{project\}/global/forwardingRules/{id\} or projects/{project\}/regions/{region\}/forwardingRules/{id\} */ forwardingRule?: string | null; /** @@ -517,7 +517,7 @@ export namespace networkmanagement_v1 { */ loadBalancerType?: string | null; /** - * A Compute Engine network URI. + * A VPC network URI. */ network?: string | null; /** @@ -529,15 +529,15 @@ export namespace networkmanagement_v1 { */ port?: number | null; /** - * Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + * Project ID where the endpoint is located. The project ID can be derived from the URI if you provide a endpoint or network URI. The following are two cases where you may need to provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. */ projectId?: string | null; /** - * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. Applicable only to destination endpoint. */ redisCluster?: string | null; /** - * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. + * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. Applicable only to destination endpoint. */ redisInstance?: string | null; } @@ -784,6 +784,10 @@ export namespace networkmanagement_v1 { * URI of the PSC network attachment the NIC is attached to (if relevant). */ pscNetworkAttachmentUri?: string | null; + /** + * Indicates whether the Compute Engine instance is running. + */ + running?: boolean | null; /** * Service account authorized for the instance. */ @@ -1165,9 +1169,13 @@ export namespace networkmanagement_v1 { */ abortCause?: string | null; /** - * The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field *must not* be used as an indication that the destination/source is part of the Google network. + * The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network. */ destinationEgressLocation?: Schema$EdgeLocation; + /** + * Probing results for all edge devices. + */ + edgeResponses?: Schema$SingleEdgeResponse[]; /** * The source and destination endpoints derived from the test input and used for active probing. */ @@ -1176,6 +1184,10 @@ export namespace networkmanagement_v1 { * Details about an internal failure or the cancellation of active probing. */ error?: Schema$Status; + /** + * Whether all relevant edge devices were probed. + */ + probedAllDevices?: boolean | null; /** * Latency as measured by active probing in one direction: from the source to the destination endpoint. */ @@ -1461,6 +1473,35 @@ export namespace networkmanagement_v1 { */ updateMask?: string | null; } + /** + * Probing results for a single edge device. + */ + export interface Schema$SingleEdgeResponse { + /** + * The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network. + */ + destinationEgressLocation?: Schema$EdgeLocation; + /** + * Router name in the format '{router\}.{metroshard\}'. For example: pf01.aaa01, pr02.aaa01. + */ + destinationRouter?: string | null; + /** + * Latency as measured by active probing in one direction: from the source to the destination endpoint. + */ + probingLatency?: Schema$LatencyDistribution; + /** + * The overall result of active probing for this egress device. + */ + result?: string | null; + /** + * Number of probes sent. + */ + sentProbeCount?: number | null; + /** + * Number of probes that reached the destination. + */ + successfulProbeCount?: 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). */ @@ -1721,7 +1762,7 @@ export namespace networkmanagement_v1 { */ name?: string | null; /** - * Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. + * Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config. */ state?: string | null; /** @@ -2018,6 +2059,10 @@ export namespace networkmanagement_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index 60815db33f5..8295deae4de 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -318,7 +318,7 @@ export namespace networkmanagement_v1beta1 { */ export interface Schema$ConnectivityTest { /** - * Whether the test should skip firewall checking. If not provided, we assume false. + * Whether the analysis should skip firewall checking. Default value is false. */ bypassFirewallChecks?: boolean | null; /** @@ -330,7 +330,7 @@ export namespace networkmanagement_v1beta1 { */ description?: string | null; /** - * Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. + * Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, URI of a supported endpoint, project ID, or VPC network to identify the destination location. Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination that you don't intend to test. */ destination?: Schema$Endpoint; /** @@ -370,7 +370,7 @@ export namespace networkmanagement_v1beta1 { */ roundTrip?: boolean | null; /** - * Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. + * Required. Source specification of the Connectivity Test. You can use a combination of source IP address, URI of a supported endpoint, project ID, or VPC network to identify the source location. Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don't intend to test. */ source?: Schema$Endpoint; /** @@ -475,15 +475,15 @@ export namespace networkmanagement_v1beta1 { */ alloyDbInstance?: string | null; /** - * An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions). + * An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions). Applicable only to source endpoint. */ appEngineVersion?: Schema$AppEngineVersionEndpoint; /** - * A [Cloud Function](https://cloud.google.com/functions). + * A [Cloud Function](https://cloud.google.com/functions). Applicable only to source endpoint. */ cloudFunction?: Schema$CloudFunctionEndpoint; /** - * A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) + * A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. */ cloudRunRevision?: Schema$CloudRunRevisionEndpoint; /** @@ -491,7 +491,7 @@ export namespace networkmanagement_v1beta1 { */ cloudSqlInstance?: string | null; /** - * A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Format: projects/{project\}/global/forwardingRules/{id\} or projects/{project\}/regions/{region\}/forwardingRules/{id\} + * A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Applicable only to destination endpoint. Format: projects/{project\}/global/forwardingRules/{id\} or projects/{project\}/regions/{region\}/forwardingRules/{id\} */ forwardingRule?: string | null; /** @@ -523,7 +523,7 @@ export namespace networkmanagement_v1beta1 { */ loadBalancerType?: string | null; /** - * A Compute Engine network URI. + * A VPC network URI. */ network?: string | null; /** @@ -535,15 +535,15 @@ export namespace networkmanagement_v1beta1 { */ port?: number | null; /** - * Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. + * Project ID where the endpoint is located. The project ID can be derived from the URI if you provide a endpoint or network URI. The following are two cases where you may need to provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project. */ projectId?: string | null; /** - * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. Applicable only to destination endpoint. */ redisCluster?: string | null; /** - * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. + * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. Applicable only to destination endpoint. */ redisInstance?: string | null; } @@ -790,6 +790,10 @@ export namespace networkmanagement_v1beta1 { * URI of the PSC network attachment the NIC is attached to (if relevant). */ pscNetworkAttachmentUri?: string | null; + /** + * Indicates whether the Compute Engine instance is running. + */ + running?: boolean | null; /** * Service account authorized for the instance. */ @@ -1171,9 +1175,13 @@ export namespace networkmanagement_v1beta1 { */ abortCause?: string | null; /** - * The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field *must not* be used as an indication that the destination/source is part of the Google network. + * The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network. */ destinationEgressLocation?: Schema$EdgeLocation; + /** + * Probing results for all edge devices. + */ + edgeResponses?: Schema$SingleEdgeResponse[]; /** * The source and destination endpoints derived from the test input and used for active probing. */ @@ -1182,6 +1190,10 @@ export namespace networkmanagement_v1beta1 { * Details about an internal failure or the cancellation of active probing. */ error?: Schema$Status; + /** + * Whether all relevant edge devices were probed. + */ + probedAllDevices?: boolean | null; /** * Latency as measured by active probing in one direction: from the source to the destination endpoint. */ @@ -1467,6 +1479,35 @@ export namespace networkmanagement_v1beta1 { */ updateMask?: string | null; } + /** + * Probing results for a single edge device. + */ + export interface Schema$SingleEdgeResponse { + /** + * The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field *must not* be used as an indication that the destination is part of the Google network. + */ + destinationEgressLocation?: Schema$EdgeLocation; + /** + * Router name in the format '{router\}.{metroshard\}'. For example: pf01.aaa01, pr02.aaa01. + */ + destinationRouter?: string | null; + /** + * Latency as measured by active probing in one direction: from the source to the destination endpoint. + */ + probingLatency?: Schema$LatencyDistribution; + /** + * The overall result of active probing for this egress device. + */ + result?: string | null; + /** + * Number of probes sent. + */ + sentProbeCount?: number | null; + /** + * Number of probes that reached the destination. + */ + successfulProbeCount?: 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). */ @@ -1727,7 +1768,7 @@ export namespace networkmanagement_v1beta1 { */ name?: string | null; /** - * Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. + * Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config. */ state?: string | null; /** @@ -2021,6 +2062,10 @@ export namespace networkmanagement_v1beta1 { } export interface Params$Resource$Organizations$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -2672,6 +2717,10 @@ export namespace networkmanagement_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index ce55e1917fb..481c23a48ac 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -894,6 +894,264 @@ export namespace networksecurity_v1 { */ regexMatch?: string | null; } + /** + * 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. 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 interceptors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124. + */ + forwardingRule?: string | null; + /** + * 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 are key/value pairs that help to organize and filter resources. + */ + labels?: {[key: string]: string} | null; + /** + * 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. 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 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 endpoint groups that are connected to this resource. + */ + connectedEndpointGroups?: Schema$InterceptDeploymentGroupConnectedEndpointGroup[]; + /** + * 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$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; + /** + * 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. 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$InterceptDeploymentGroupConnectedEndpointGroup { + /** + * 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; + } + /** + * 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 associations to this endpoint group. + */ + associations?: Schema$InterceptEndpointGroupAssociationDetails[]; + /** + * 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; + /** + * Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group. + */ + description?: string | null; + /** + * 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 are key/value pairs that help to organize and filter resources. + */ + labels?: {[key: string]: string} | null; + /** + * 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. 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 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. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. + */ + createTime?: string | null; + /** + * 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 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$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 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 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$InterceptEndpointGroupAssociationDetails { + /** + * 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 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$InterceptEndpointGroupAssociationLocationDetails { + /** + * 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 current state of the association in this location. + */ + state?: string | null; + } /** * Response of the ListAddressGroupReferences method. */ @@ -1053,39 +1311,26 @@ export namespace networksecurity_v1 { unreachable?: string[] | null; } /** - * The response message for Locations.ListLocations. - */ - export interface Schema$ListLocationsResponse { - /** - * A list of locations that matches the specified filter in the request. - */ - locations?: Schema$Location[]; - /** - * The standard List next-page token. - */ - nextPageToken?: string | null; - } - /** - * Response message for ListMirroringDeploymentGroups. + * Response message for ListInterceptDeploymentGroups. */ - export interface Schema$ListMirroringDeploymentGroupsResponse { + export interface Schema$ListInterceptDeploymentGroupsResponse { /** * The deployment groups from the specified parent. */ - mirroringDeploymentGroups?: Schema$MirroringDeploymentGroup[]; + interceptDeploymentGroups?: Schema$InterceptDeploymentGroup[]; /** * 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. + * Response message for ListInterceptDeployments. */ - export interface Schema$ListMirroringDeploymentsResponse { + export interface Schema$ListInterceptDeploymentsResponse { /** * The deployments from the specified parent. */ - mirroringDeployments?: Schema$MirroringDeployment[]; + interceptDeployments?: Schema$InterceptDeployment[]; /** * 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. */ @@ -1096,46 +1341,115 @@ export namespace networksecurity_v1 { unreachable?: string[] | null; } /** - * Response message for ListMirroringEndpointGroupAssociations. + * Response message for ListInterceptEndpointGroupAssociations. */ - export interface Schema$ListMirroringEndpointGroupAssociationsResponse { + export interface Schema$ListInterceptEndpointGroupAssociationsResponse { /** * The associations from the specified parent. */ - mirroringEndpointGroupAssociations?: Schema$MirroringEndpointGroupAssociation[]; + interceptEndpointGroupAssociations?: Schema$InterceptEndpointGroupAssociation[]; /** * 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. + * Response message for ListInterceptEndpointGroups. */ - export interface Schema$ListMirroringEndpointGroupsResponse { + export interface Schema$ListInterceptEndpointGroupsResponse { /** * The endpoint groups from the specified parent. */ - mirroringEndpointGroups?: Schema$MirroringEndpointGroup[]; + interceptEndpointGroups?: Schema$InterceptEndpointGroup[]; /** * 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. + * The response message for Locations.ListLocations. */ - export interface Schema$ListOperationsResponse { + export interface Schema$ListLocationsResponse { /** - * The standard List next-page token. + * A list of locations that matches the specified filter in the request. */ - nextPageToken?: string | null; + locations?: Schema$Location[]; /** - * A list of operations that matches the specified filter in the request. + * The standard List next-page token. */ - operations?: Schema$Operation[]; + nextPageToken?: string | null; } /** - * Response returned by the ListSecurityProfileGroups method. + * 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. + */ + 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 returned by the ListSecurityProfileGroups method. */ export interface Schema$ListSecurityProfileGroupsResponse { /** @@ -4885,6 +5199,10 @@ export namespace networksecurity_v1 { clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; firewallEndpointAssociations: Resource$Projects$Locations$Firewallendpointassociations; gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; + interceptDeploymentGroups: Resource$Projects$Locations$Interceptdeploymentgroups; + interceptDeployments: Resource$Projects$Locations$Interceptdeployments; + interceptEndpointGroupAssociations: Resource$Projects$Locations$Interceptendpointgroupassociations; + interceptEndpointGroups: Resource$Projects$Locations$Interceptendpointgroups; mirroringDeploymentGroups: Resource$Projects$Locations$Mirroringdeploymentgroups; mirroringDeployments: Resource$Projects$Locations$Mirroringdeployments; mirroringEndpointGroupAssociations: Resource$Projects$Locations$Mirroringendpointgroupassociations; @@ -4911,6 +5229,16 @@ export namespace networksecurity_v1 { ); this.gatewaySecurityPolicies = new Resource$Projects$Locations$Gatewaysecuritypolicies(this.context); + this.interceptDeploymentGroups = + new Resource$Projects$Locations$Interceptdeploymentgroups(this.context); + this.interceptDeployments = + new Resource$Projects$Locations$Interceptdeployments(this.context); + this.interceptEndpointGroupAssociations = + new Resource$Projects$Locations$Interceptendpointgroupassociations( + this.context + ); + this.interceptEndpointGroups = + new Resource$Projects$Locations$Interceptendpointgroups(this.context); this.mirroringDeploymentGroups = new Resource$Projects$Locations$Mirroringdeploymentgroups(this.context); this.mirroringDeployments = @@ -5121,6 +5449,10 @@ export namespace networksecurity_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -8351,95 +8683,2266 @@ export namespace networksecurity_v1 { options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - 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); + } + } + + /** + * 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( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists ClientTlsPolicies 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$Clienttlspolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Clienttlspolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clienttlspolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clienttlspolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$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}/clientTlsPolicies').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 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. + */ + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$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); + } + } + + /** + * 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$Clienttlspolicies$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Create + extends StandardParameters { + /** + * Required. Short name of the ClientTlsPolicy 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. "client_mtls_policy". + */ + clientTlsPolicyId?: string; + /** + * Required. The parent resource of the ClientTlsPolicy. Must be in the format `projects/x/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ClientTlsPolicy; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Delete + extends StandardParameters { + /** + * Required. A name of the ClientTlsPolicy to delete. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Get + extends StandardParameters { + /** + * Required. A name of the ClientTlsPolicy to get. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$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$Clienttlspolicies$List + extends StandardParameters { + /** + * Maximum number of ClientTlsPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListClientTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListClientTlsPolicies` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the ClientTlsPolicies should be listed, specified in the format `projects/x/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$Patch + extends StandardParameters { + /** + * Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/x/locations/{location\}/clientTlsPolicies/{client_tls_policy\}` + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy 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$ClientTlsPolicy; + } + export interface Params$Resource$Projects$Locations$Clienttlspolicies$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$Clienttlspolicies$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$Firewallendpointassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new FirewallEndpointAssociation 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$Firewallendpointassociations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Firewallendpointassociations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$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}/firewallEndpointAssociations' + ).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 FirewallEndpointAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Firewallendpointassociations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Firewallendpointassociations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$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 details of a single FirewallEndpointAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Firewallendpointassociations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Firewallendpointassociations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Firewallendpointassociations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Firewallendpointassociations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$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}/firewallEndpointAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update a single FirewallEndpointAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Firewallendpointassociations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Firewallendpointassociations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Firewallendpointassociations$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$Firewallendpointassociations$Create + extends StandardParameters { + /** + * Optional. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_association_id from the method_signature of Create RPC. + */ + firewallEndpointAssociationId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallEndpointAssociation; + } + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Delete + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Get + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$List + extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * 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; + /** + * A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListAssociationsRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Patch + extends StandardParameters { + /** + * Immutable. Identifier. name of resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the Association 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$FirewallEndpointAssociation; + } + + export class Resource$Projects$Locations$Gatewaysecuritypolicies { + context: APIRequestContext; + rules: Resource$Projects$Locations$Gatewaysecuritypolicies$Rules; + constructor(context: APIRequestContext) { + this.context = context; + this.rules = + new Resource$Projects$Locations$Gatewaysecuritypolicies$Rules( + this.context + ); + } + + /** + * Creates a new GatewaySecurityPolicy 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$Gatewaysecuritypolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$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}/gatewaySecurityPolicies').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 GatewaySecurityPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Gatewaysecuritypolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$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 details of a single GatewaySecurityPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Gatewaysecuritypolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$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 GatewaySecurityPolicies 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$Gatewaysecuritypolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$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}/gatewaySecurityPolicies').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 GatewaySecurityPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Gatewaysecuritypolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$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$Gatewaysecuritypolicies$Create + extends StandardParameters { + /** + * Required. Short name of the GatewaySecurityPolicy 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. "gateway_security_policy1". + */ + gatewaySecurityPolicyId?: string; + /** + * Required. The parent resource of the GatewaySecurityPolicy. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GatewaySecurityPolicy; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete + extends StandardParameters { + /** + * Required. A name of the GatewaySecurityPolicy to delete. Must be in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get + extends StandardParameters { + /** + * Required. A name of the GatewaySecurityPolicy to get. Must be in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List + extends StandardParameters { + /** + * Maximum number of GatewaySecurityPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last 'ListGatewaySecurityPoliciesResponse' Indicates that this is a continuation of a prior 'ListGatewaySecurityPolicies' call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the GatewaySecurityPolicies should be listed, specified in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch + extends StandardParameters { + /** + * Required. Name of the resource. Name is of the form projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gateway_security_policy\} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the GatewaySecurityPolicy 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$GatewaySecurityPolicy; + } + + export class Resource$Projects$Locations$Gatewaysecuritypolicies$Rules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new GatewaySecurityPolicy 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$Gatewaysecuritypolicies$Rules$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$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}/rules').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 GatewaySecurityPolicyRule. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Gatewaysecuritypolicies$Rules$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$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 details of a single GatewaySecurityPolicyRule. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Gatewaysecuritypolicies$Rules$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$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 GatewaySecurityPolicyRules 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$Gatewaysecuritypolicies$Rules$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$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}/rules').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 GatewaySecurityPolicyRule. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Gatewaysecuritypolicies$Rules$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$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$Gatewaysecuritypolicies$Rules$Create + extends StandardParameters { + /** + * The ID to use for the rule, which will become the final component of the rule's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. + */ + gatewaySecurityPolicyRuleId?: string; + /** + * Required. The parent where this rule will be created. Format : projects/{project\}/location/{location\}/gatewaySecurityPolicies/x + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GatewaySecurityPolicyRule; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete + extends StandardParameters { + /** + * Required. A name of the GatewaySecurityPolicyRule to delete. Must be in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gatewaySecurityPolicy\}/rules/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get + extends StandardParameters { + /** + * Required. The name of the GatewaySecurityPolicyRule to retrieve. Format: projects/{project\}/location/{location\}/gatewaySecurityPolicies/x/rules/x + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List + extends StandardParameters { + /** + * Maximum number of GatewaySecurityPolicyRules to return per call. + */ + pageSize?: number; + /** + * The value returned by the last 'ListGatewaySecurityPolicyRulesResponse' Indicates that this is a continuation of a prior 'ListGatewaySecurityPolicyRules' call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project, location and GatewaySecurityPolicy from which the GatewaySecurityPolicyRules should be listed, specified in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gatewaySecurityPolicy\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch + extends StandardParameters { + /** + * Required. Immutable. Name of the resource. ame is the full resource name so projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gateway_security_policy\}/rules/{rule\} rule should match the pattern: (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the GatewaySecurityPolicy 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$GatewaySecurityPolicyRule; + } - 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); - } + export class Resource$Projects$Locations$Interceptdeploymentgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a 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. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create, 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 + create( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy; + {} as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create; options = {}; } @@ -8453,90 +10956,83 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/interceptDeploymentGroups').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ClientTlsPolicies in a given project and location. + * 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. */ - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, + delete( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$List, + delete( + params?: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Clienttlspolicies$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$List; + {}) as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$List; + {} as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete; options = {}; } @@ -8550,85 +11046,85 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/clientTlsPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single ClientTlsPolicy. + * 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. */ - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + get( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + get( + params?: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptdeploymentgroups$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$Patch; + {}) as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Patch; + {} as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get; options = {}; } @@ -8643,7 +11139,7 @@ export namespace networksecurity_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -8654,73 +11150,75 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists 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. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Interceptdeploymentgroups$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptdeploymentgroups$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$Clienttlspolicies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Interceptdeploymentgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy; + {} as Params$Resource$Projects$Locations$Interceptdeploymentgroups$List; options = {}; } @@ -8734,90 +11232,85 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/interceptDeploymentGroups').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates 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. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions; + {} as Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch; options = {}; } @@ -8831,138 +11324,118 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Create + export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create extends StandardParameters { /** - * Required. Short name of the ClientTlsPolicy 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. "client_mtls_policy". + * Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name. */ - clientTlsPolicyId?: string; + interceptDeploymentGroupId?: string; /** - * Required. The parent resource of the ClientTlsPolicy. Must be in the format `projects/x/locations/{location\}`. + * 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$ClientTlsPolicy; + requestBody?: Schema$InterceptDeploymentGroup; } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Delete + export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete extends StandardParameters { /** - * Required. A name of the ClientTlsPolicy to delete. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + * 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$Clienttlspolicies$Get + export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get extends StandardParameters { /** - * Required. A name of the ClientTlsPolicy to get. Must be in the format `projects/x/locations/{location\}/clientTlsPolicies/x`. + * 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$Clienttlspolicies$Getiampolicy + export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$List extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ - 'options.requestedPolicyVersion'?: number; + filter?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of ClientTlsPolicies to return per call. + * 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; /** - * The value returned by the last `ListClientTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListClientTlsPolicies` call, and that the system should return the next page of data. + * 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. The project and location from which the ClientTlsPolicies should be listed, specified in the format `projects/x/locations/{location\}`. + * 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$Clienttlspolicies$Patch + export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch extends StandardParameters { /** - * Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/x/locations/{location\}/clientTlsPolicies/{client_tls_policy\}` + * 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. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy 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$ClientTlsPolicy; - } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. 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. */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Clienttlspolicies$Testiampermissions - extends StandardParameters { + requestId?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. 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. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + requestBody?: Schema$InterceptDeploymentGroup; } - export class Resource$Projects$Locations$Firewallendpointassociations { + export class Resource$Projects$Locations$Interceptdeployments { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new FirewallEndpointAssociation 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`. @@ -8970,31 +11443,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + params: Params$Resource$Projects$Locations$Interceptdeployments$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + params?: Params$Resource$Projects$Locations$Interceptdeployments$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + params: Params$Resource$Projects$Locations$Interceptdeployments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + params: Params$Resource$Projects$Locations$Interceptdeployments$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Create, + params: Params$Resource$Projects$Locations$Interceptdeployments$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Firewallendpointassociations$Create + | Params$Resource$Projects$Locations$Interceptdeployments$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9007,13 +11480,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Create; + {}) as Params$Resource$Projects$Locations$Interceptdeployments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Create; + {} as Params$Resource$Projects$Locations$Interceptdeployments$Create; options = {}; } @@ -9027,9 +11500,10 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/firewallEndpointAssociations' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/interceptDeployments').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -9051,7 +11525,7 @@ export namespace networksecurity_v1 { } /** - * Deletes a single FirewallEndpointAssociation. + * 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`. @@ -9059,31 +11533,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + params: Params$Resource$Projects$Locations$Interceptdeployments$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + params?: Params$Resource$Projects$Locations$Interceptdeployments$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + params: Params$Resource$Projects$Locations$Interceptdeployments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + params: Params$Resource$Projects$Locations$Interceptdeployments$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Delete, + params: Params$Resource$Projects$Locations$Interceptdeployments$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Firewallendpointassociations$Delete + | Params$Resource$Projects$Locations$Interceptdeployments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9096,13 +11570,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Delete; + {}) as Params$Resource$Projects$Locations$Interceptdeployments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Delete; + {} as Params$Resource$Projects$Locations$Interceptdeployments$Delete; options = {}; } @@ -9138,7 +11612,7 @@ export namespace networksecurity_v1 { } /** - * Gets details of a single FirewallEndpointAssociation. + * 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`. @@ -9146,57 +11620,53 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + params: Params$Resource$Projects$Locations$Interceptdeployments$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + params?: Params$Resource$Projects$Locations$Interceptdeployments$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, + params: Params$Resource$Projects$Locations$Interceptdeployments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Interceptdeployments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Interceptdeployments$Get, + callback: BodyResponseCallback ): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Firewallendpointassociations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptdeployments$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$Firewallendpointassociations$Get; + {}) as Params$Resource$Projects$Locations$Interceptdeployments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Get; + {} as Params$Resource$Projects$Locations$Interceptdeployments$Get; options = {}; } @@ -9222,17 +11692,17 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Associations 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`. @@ -9240,57 +11710,57 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + params: Params$Resource$Projects$Locations$Interceptdeployments$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + params?: Params$Resource$Projects$Locations$Interceptdeployments$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + params: Params$Resource$Projects$Locations$Interceptdeployments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, + params: Params$Resource$Projects$Locations$Interceptdeployments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Interceptdeployments$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Firewallendpointassociations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptdeployments$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$Firewallendpointassociations$List; + {}) as Params$Resource$Projects$Locations$Interceptdeployments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Firewallendpointassociations$List; + {} as Params$Resource$Projects$Locations$Interceptdeployments$List; options = {}; } @@ -9304,9 +11774,10 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/firewallEndpointAssociations' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/interceptDeployments').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -9318,19 +11789,19 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Update a single FirewallEndpointAssociation. + * 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`. @@ -9338,31 +11809,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + params: Params$Resource$Projects$Locations$Interceptdeployments$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + params?: Params$Resource$Projects$Locations$Interceptdeployments$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + params: Params$Resource$Projects$Locations$Interceptdeployments$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + params: Params$Resource$Projects$Locations$Interceptdeployments$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Firewallendpointassociations$Patch, + params: Params$Resource$Projects$Locations$Interceptdeployments$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Firewallendpointassociations$Patch + | Params$Resource$Projects$Locations$Interceptdeployments$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9375,13 +11846,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Firewallendpointassociations$Patch; + {}) as Params$Resource$Projects$Locations$Interceptdeployments$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Firewallendpointassociations$Patch; + {} as Params$Resource$Projects$Locations$Interceptdeployments$Patch; options = {}; } @@ -9417,101 +11888,96 @@ export namespace networksecurity_v1 { } } - export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Create + export interface Params$Resource$Projects$Locations$Interceptdeployments$Create extends StandardParameters { /** - * Optional. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_association_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. */ - firewallEndpointAssociationId?: string; + 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; /** * Request body metadata */ - requestBody?: Schema$FirewallEndpointAssociation; + requestBody?: Schema$InterceptDeployment; } - export interface Params$Resource$Projects$Locations$Firewallendpointassociations$Delete + export interface Params$Resource$Projects$Locations$Interceptdeployments$Delete extends StandardParameters { /** * Required. Name of the resource */ name?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * 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$Firewallendpointassociations$Get + 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$Firewallendpointassociations$List + 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; /** - * 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; /** - * 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 ListAssociationsRequest + * 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$Firewallendpointassociations$Patch + export interface Params$Resource$Projects$Locations$Interceptdeployments$Patch extends StandardParameters { /** - * Immutable. Identifier. name of resource + * 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 Association 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; /** * Request body metadata */ - requestBody?: Schema$FirewallEndpointAssociation; + requestBody?: Schema$InterceptDeployment; } - export class Resource$Projects$Locations$Gatewaysecuritypolicies { + export class Resource$Projects$Locations$Interceptendpointgroupassociations { context: APIRequestContext; - rules: Resource$Projects$Locations$Gatewaysecuritypolicies$Rules; constructor(context: APIRequestContext) { this.context = context; - this.rules = - new Resource$Projects$Locations$Gatewaysecuritypolicies$Rules( - this.context - ); } /** - * Creates a new GatewaySecurityPolicy 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`. @@ -9519,31 +11985,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + params?: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create + | Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9556,13 +12022,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create; + {} as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create; options = {}; } @@ -9576,10 +12042,9 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/gatewaySecurityPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/interceptEndpointGroupAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -9601,7 +12066,7 @@ export namespace networksecurity_v1 { } /** - * Deletes a single GatewaySecurityPolicy. + * 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`. @@ -9609,31 +12074,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + params?: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete + | Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9646,13 +12111,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete; + {} as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete; options = {}; } @@ -9688,7 +12153,7 @@ export namespace networksecurity_v1 { } /** - * Gets details of a single GatewaySecurityPolicy. + * 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`. @@ -9696,55 +12161,57 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + params?: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptendpointgroupassociations$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$Gatewaysecuritypolicies$Get; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Get; + {} as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get; options = {}; } @@ -9770,17 +12237,19 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists GatewaySecurityPolicies 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`. @@ -9788,57 +12257,57 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + params?: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptendpointgroupassociations$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$Gatewaysecuritypolicies$List; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$List; + {} as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List; options = {}; } @@ -9852,10 +12321,9 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/gatewaySecurityPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/interceptEndpointGroupAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -9867,19 +12335,19 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single GatewaySecurityPolicy. + * 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`. @@ -9887,31 +12355,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + params?: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch + | Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9924,13 +12392,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Patch; + {} as Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch; options = {}; } @@ -9966,76 +12434,96 @@ export namespace networksecurity_v1 { } } - export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Create + export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create extends StandardParameters { /** - * Required. Short name of the GatewaySecurityPolicy 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. "gateway_security_policy1". + * 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. */ - gatewaySecurityPolicyId?: string; + interceptEndpointGroupAssociationId?: string; /** - * Required. The parent resource of the GatewaySecurityPolicy. Must be in the format `projects/{project\}/locations/{location\}`. + * 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$GatewaySecurityPolicy; + requestBody?: Schema$InterceptEndpointGroupAssociation; } - export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Delete + export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete extends StandardParameters { /** - * Required. A name of the GatewaySecurityPolicy to delete. Must be in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/x`. + * 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$Gatewaysecuritypolicies$Get + export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get extends StandardParameters { /** - * Required. A name of the GatewaySecurityPolicy to get. Must be in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/x`. + * 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$Gatewaysecuritypolicies$List + export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List extends StandardParameters { /** - * Maximum number of GatewaySecurityPolicies to return per call. + * 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; /** - * The value returned by the last 'ListGatewaySecurityPoliciesResponse' Indicates that this is a continuation of a prior 'ListGatewaySecurityPolicies' call, and that the system should return the next page of data. + * 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. The project and location from which the GatewaySecurityPolicies should be listed, specified in the format `projects/{project\}/locations/{location\}`. + * 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$Gatewaysecuritypolicies$Patch + export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch extends StandardParameters { /** - * Required. Name of the resource. Name is of the form projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gateway_security_policy\} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). + * 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. Field mask is used to specify the fields to be overwritten in the GatewaySecurityPolicy 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. 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* `intercept_endpoint_group_association.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GatewaySecurityPolicy; + requestBody?: Schema$InterceptEndpointGroupAssociation; } - export class Resource$Projects$Locations$Gatewaysecuritypolicies$Rules { + export class Resource$Projects$Locations$Interceptendpointgroups { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new GatewaySecurityPolicy 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`. @@ -10043,31 +12531,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + params?: Params$Resource$Projects$Locations$Interceptendpointgroups$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create + | Params$Resource$Projects$Locations$Interceptendpointgroups$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10080,13 +12568,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroups$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create; + {} as Params$Resource$Projects$Locations$Interceptendpointgroups$Create; options = {}; } @@ -10100,7 +12588,7 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/rules').replace( + url: (rootUrl + '/v1/{+parent}/interceptEndpointGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -10125,7 +12613,7 @@ export namespace networksecurity_v1 { } /** - * Deletes a single GatewaySecurityPolicyRule. + * 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`. @@ -10133,31 +12621,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + params?: Params$Resource$Projects$Locations$Interceptendpointgroups$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete + | Params$Resource$Projects$Locations$Interceptendpointgroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10170,13 +12658,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete; + {} as Params$Resource$Projects$Locations$Interceptendpointgroups$Delete; options = {}; } @@ -10212,7 +12700,7 @@ export namespace networksecurity_v1 { } /** - * Gets details of a single GatewaySecurityPolicyRule. + * 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`. @@ -10220,55 +12708,55 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + params?: Params$Resource$Projects$Locations$Interceptendpointgroups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptendpointgroups$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$Gatewaysecuritypolicies$Rules$Get; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Get; + {} as Params$Resource$Projects$Locations$Interceptendpointgroups$Get; options = {}; } @@ -10294,17 +12782,17 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists GatewaySecurityPolicyRules 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`. @@ -10312,57 +12800,57 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + params?: Params$Resource$Projects$Locations$Interceptendpointgroups$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Interceptendpointgroups$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Interceptendpointgroups$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$Gatewaysecuritypolicies$Rules$List; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$List; + {} as Params$Resource$Projects$Locations$Interceptendpointgroups$List; options = {}; } @@ -10376,7 +12864,7 @@ export namespace networksecurity_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/rules').replace( + url: (rootUrl + '/v1/{+parent}/interceptEndpointGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -10391,19 +12879,19 @@ export namespace networksecurity_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single GatewaySecurityPolicyRule. + * 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`. @@ -10411,31 +12899,31 @@ export namespace networksecurity_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + params?: Params$Resource$Projects$Locations$Interceptendpointgroups$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch, + params: Params$Resource$Projects$Locations$Interceptendpointgroups$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch + | Params$Resource$Projects$Locations$Interceptendpointgroups$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10448,13 +12936,13 @@ export namespace networksecurity_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch; + {}) as Params$Resource$Projects$Locations$Interceptendpointgroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Patch; + {} as Params$Resource$Projects$Locations$Interceptendpointgroups$Patch; options = {}; } @@ -10490,66 +12978,86 @@ export namespace networksecurity_v1 { } } - export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Create + export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Create extends StandardParameters { /** - * The ID to use for the rule, which will become the final component of the rule's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. + * Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name. */ - gatewaySecurityPolicyRuleId?: string; + interceptEndpointGroupId?: string; /** - * Required. The parent where this rule will be created. Format : projects/{project\}/location/{location\}/gatewaySecurityPolicies/x + * 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$GatewaySecurityPolicyRule; + requestBody?: Schema$InterceptEndpointGroup; } - export interface Params$Resource$Projects$Locations$Gatewaysecuritypolicies$Rules$Delete + export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Delete extends StandardParameters { /** - * Required. A name of the GatewaySecurityPolicyRule to delete. Must be in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gatewaySecurityPolicy\}/rules/x`. + * 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$Gatewaysecuritypolicies$Rules$Get + export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Get extends StandardParameters { /** - * Required. The name of the GatewaySecurityPolicyRule to retrieve. Format: projects/{project\}/location/{location\}/gatewaySecurityPolicies/x/rules/x + * 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$Gatewaysecuritypolicies$Rules$List + export interface Params$Resource$Projects$Locations$Interceptendpointgroups$List extends StandardParameters { /** - * Maximum number of GatewaySecurityPolicyRules to return per call. + * 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; /** - * The value returned by the last 'ListGatewaySecurityPolicyRulesResponse' Indicates that this is a continuation of a prior 'ListGatewaySecurityPolicyRules' call, and that the system should return the next page of data. + * 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. The project, location and GatewaySecurityPolicy from which the GatewaySecurityPolicyRules should be listed, specified in the format `projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gatewaySecurityPolicy\}`. + * 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$Gatewaysecuritypolicies$Rules$Patch + export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Patch extends StandardParameters { /** - * Required. Immutable. Name of the resource. ame is the full resource name so projects/{project\}/locations/{location\}/gatewaySecurityPolicies/{gateway_security_policy\}/rules/{rule\} rule should match the pattern: (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). + * 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. Field mask is used to specify the fields to be overwritten in the GatewaySecurityPolicy 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. 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* `intercept_endpoint_group.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GatewaySecurityPolicyRule; + requestBody?: Schema$InterceptEndpointGroup; } export class Resource$Projects$Locations$Mirroringdeploymentgroups { diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index fce8d634bd0..89f3a459218 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -5515,6 +5515,10 @@ export namespace networksecurity_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index c604390d2af..7d726317bf8 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -371,7 +371,7 @@ export namespace networkservices_v1 { */ forwardHeaders?: string[] | null; /** - * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. */ metadata?: {[key: string]: any} | null; /** @@ -387,7 +387,7 @@ export namespace networkservices_v1 { */ supportedEvents?: string[] | null; /** - * Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`1000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. */ timeout?: string | null; } @@ -710,7 +710,7 @@ export namespace networkservices_v1 { */ export interface Schema$GrpcRouteStatefulSessionAffinityPolicy { /** - * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration. */ cookieTtl?: string | null; } @@ -1128,7 +1128,7 @@ export namespace networkservices_v1 { */ export interface Schema$HttpRouteStatefulSessionAffinityPolicy { /** - * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration. */ cookieTtl?: string | null; } @@ -1162,7 +1162,7 @@ export namespace networkservices_v1 { */ extensionChains?: Schema$ExtensionChain[]; /** - * Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LbRouteExtension` resource per forwarding rule. + * Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbRouteExtension` resource can be associated with a forwarding rule. */ forwardingRules?: string[] | null; /** @@ -1174,7 +1174,7 @@ export namespace networkservices_v1 { */ loadBalancingScheme?: string | null; /** - * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_route_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. */ metadata?: {[key: string]: any} | null; /** @@ -1203,7 +1203,7 @@ export namespace networkservices_v1 { */ extensionChains?: Schema$ExtensionChain[]; /** - * Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LBTrafficExtension` resource per forwarding rule. + * Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbTrafficExtension` resource can be associated with a forwarding rule. */ forwardingRules?: string[] | null; /** @@ -1215,7 +1215,7 @@ export namespace networkservices_v1 { */ loadBalancingScheme?: string | null; /** - * Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. */ metadata?: {[key: string]: any} | null; /** @@ -1256,6 +1256,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 ListGatewayRouteViews method. @@ -1303,6 +1307,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 ListHttpRoutes method. @@ -1316,6 +1324,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; } /** * Message for response to listing `LbRouteExtension` resources. @@ -1457,6 +1469,10 @@ export namespace networkservices_v1 { * List of TcpRoute resources. */ tcpRoutes?: Schema$TcpRoute[]; + /** + * 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 ListTlsRoutes method. @@ -1470,6 +1486,10 @@ export namespace networkservices_v1 { * List of TlsRoute resources. */ tlsRoutes?: Schema$TlsRoute[]; + /** + * 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 `ListWasmPlugins` method. @@ -1479,6 +1499,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 attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; /** * List of `WasmPlugin` resources. */ @@ -1492,6 +1516,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 attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; /** * List of `WasmPluginVersion` resources. */ @@ -1679,7 +1707,7 @@ export namespace networkservices_v1 { cryptoKeyName?: string | null; } /** - * 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. + * ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. This feature will be deprecated soon. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers. - Bind a Cloud Run service to be used in consumer Cloud Service Mesh or Application Load Balancers. */ export interface Schema$ServiceBinding { /** @@ -1699,11 +1727,11 @@ export namespace networkservices_v1 { */ name?: string | null; /** - * Optional. The full Service Directory Service name of the format `projects/x/locations/x/namespaces/x/services/x`. This field must be set. + * Optional. The full Service Directory Service name of the format `projects/x/locations/x/namespaces/x/services/x`. This field is for Service Directory integration which will be deprecated soon. */ service?: string | null; /** - * 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. + * 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. This field is for Service Directory integration which will be deprecated soon. */ serviceId?: string | null; /** @@ -1974,7 +2002,7 @@ export namespace networkservices_v1 { */ serviceName?: string | null; /** - * Optional. Specifies the proportion of requests forwareded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100. + * Optional. Specifies the proportion of requests forwarded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100. */ weight?: number | null; } @@ -2428,6 +2456,10 @@ export namespace networkservices_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -4439,6 +4471,10 @@ export namespace networkservices_v1 { * Required. The project and location from which the EndpointPolicies 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$Endpointpolicies$Patch extends StandardParameters { @@ -5679,6 +5715,10 @@ export namespace networkservices_v1 { * Required. The project and location from which the GrpcRoutes 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$Grpcroutes$Patch extends StandardParameters { @@ -6189,6 +6229,10 @@ export namespace networkservices_v1 { * Required. The project and location from which the HttpRoutes 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$Httproutes$Patch extends StandardParameters { @@ -9843,6 +9887,10 @@ export namespace networkservices_v1 { * Required. The project and location from which the TcpRoutes 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$Tcproutes$Patch extends StandardParameters { @@ -10353,6 +10401,10 @@ export namespace networkservices_v1 { * Required. The project and location from which the TlsRoutes 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$Tlsroutes$Patch extends StandardParameters { diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 6341ecadc7b..35140516d83 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -268,6 +268,10 @@ export namespace networkservices_v1beta1 { * A single extension in the chain to execute for the matching request. */ export interface Schema$ExtensionChainExtension { + /** + * Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + */ + allowDynamicForwarding?: boolean | null; /** * Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. */ @@ -281,13 +285,21 @@ export namespace networkservices_v1beta1 { */ forwardHeaders?: string[] | null; /** - * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. */ metadata?: {[key: string]: any} | null; /** * Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. */ name?: string | null; + /** + * Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. + */ + requestBodySendMode?: string | null; + /** + * Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + */ + responseBodySendMode?: string | null; /** * Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/backendServices/{backendService\}` or `https://www.googleapis.com/compute/v1/projects/{project\}/global/backendServices/{backendService\}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project\}/locations/{location\}/wasmPlugins/{plugin\}` or `//networkservices.googleapis.com/projects/{project\}/locations/{location\}/wasmPlugins/{wasmPlugin\}`. Plugin extensions are currently supported for the `LbTrafficExtension` and the `LbRouteExtension` resources. */ @@ -620,7 +632,7 @@ export namespace networkservices_v1beta1 { */ export interface Schema$GrpcRouteStatefulSessionAffinityPolicy { /** - * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration. */ cookieTtl?: string | null; } @@ -1038,7 +1050,7 @@ export namespace networkservices_v1beta1 { */ export interface Schema$HttpRouteStatefulSessionAffinityPolicy { /** - * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration. */ cookieTtl?: string | null; } @@ -1055,6 +1067,43 @@ export namespace networkservices_v1beta1 { */ pathPrefixRewrite?: string | null; } + /** + * `LbEdgeExtension` is a resource that lets the extension service influence the Backend Service selection or Cloud CDN cache keys by modifying the request headers. + */ + export interface Schema$LbEdgeExtension { + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. A human-readable description of the resource. + */ + description?: string | null; + /** + * Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. + */ + extensionChains?: Schema$ExtensionChain[]; + /** + * Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule. + */ + forwardingRules?: string[] | null; + /** + * Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources. + */ + labels?: {[key: string]: string} | null; + /** + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + */ + loadBalancingScheme?: string | null; + /** + * Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. + */ + name?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + } /** * `LbRouteExtension` is a resource that lets you control where traffic is routed to for a given request. */ @@ -1072,7 +1121,7 @@ export namespace networkservices_v1beta1 { */ extensionChains?: Schema$ExtensionChain[]; /** - * Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LbRouteExtension` resource per forwarding rule. + * Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbRouteExtension` resource can be associated with a forwarding rule. */ forwardingRules?: string[] | null; /** @@ -1084,7 +1133,7 @@ export namespace networkservices_v1beta1 { */ loadBalancingScheme?: string | null; /** - * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_route_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. */ metadata?: {[key: string]: any} | null; /** @@ -1113,7 +1162,7 @@ export namespace networkservices_v1beta1 { */ extensionChains?: Schema$ExtensionChain[]; /** - * Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. There can be only one `LBTrafficExtension` resource per forwarding rule. + * Optional. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbTrafficExtension` resource can be associated with a forwarding rule. */ forwardingRules?: string[] | null; /** @@ -1125,7 +1174,7 @@ export namespace networkservices_v1beta1 { */ loadBalancingScheme?: string | null; /** - * Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata applies to all extensions in all extensions chains in this resource. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. */ metadata?: {[key: string]: any} | null; /** @@ -1166,6 +1215,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 ListGatewayRouteViews method. @@ -1213,6 +1266,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 ListHttpRoutes method. @@ -1226,6 +1283,27 @@ 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; + } + /** + * Message for response to listing `LbEdgeExtension` resources. + */ + export interface Schema$ListLbEdgeExtensionsResponse { + /** + * The list of `LbEdgeExtension` resources. + */ + lbEdgeExtensions?: Schema$LbEdgeExtension[]; + /** + * A token identifying a page of results that the server returns. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; } /** * Message for response to listing `LbRouteExtension` resources. @@ -1367,6 +1445,10 @@ export namespace networkservices_v1beta1 { * List of TcpRoute resources. */ tcpRoutes?: Schema$TcpRoute[]; + /** + * 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 ListTlsRoutes method. @@ -1380,6 +1462,10 @@ export namespace networkservices_v1beta1 { * List of TlsRoute resources. */ tlsRoutes?: Schema$TlsRoute[]; + /** + * 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 `ListWasmPlugins` method. @@ -1389,6 +1475,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 attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; /** * List of `WasmPlugin` resources. */ @@ -1402,6 +1492,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 attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; /** * List of `WasmPluginVersion` resources. */ @@ -1594,7 +1688,7 @@ export namespace networkservices_v1beta1 { cryptoKeyName?: string | null; } /** - * 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. + * ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. This feature will be deprecated soon. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers. - Bind a Cloud Run service to be used in consumer Cloud Service Mesh or Application Load Balancers. */ export interface Schema$ServiceBinding { /** @@ -1614,11 +1708,11 @@ export namespace networkservices_v1beta1 { */ name?: string | null; /** - * Optional. The full Service Directory Service name of the format `projects/x/locations/x/namespaces/x/services/x`. This field must be set. + * Optional. The full Service Directory Service name of the format `projects/x/locations/x/namespaces/x/services/x`. This field is for Service Directory integration which will be deprecated soon. */ service?: string | null; /** - * 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. + * 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. This field is for Service Directory integration which will be deprecated soon. */ serviceId?: string | null; /** @@ -1858,7 +1952,7 @@ export namespace networkservices_v1beta1 { */ serviceName?: string | null; /** - * Optional. Specifies the proportion of requests forwareded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100. + * Optional. Specifies the proportion of requests forwarded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100. */ weight?: number | null; } @@ -2067,6 +2161,7 @@ export namespace networkservices_v1beta1 { gateways: Resource$Projects$Locations$Gateways; grpcRoutes: Resource$Projects$Locations$Grpcroutes; httpRoutes: Resource$Projects$Locations$Httproutes; + lbEdgeExtensions: Resource$Projects$Locations$Lbedgeextensions; lbRouteExtensions: Resource$Projects$Locations$Lbrouteextensions; lbTrafficExtensions: Resource$Projects$Locations$Lbtrafficextensions; meshes: Resource$Projects$Locations$Meshes; @@ -2091,6 +2186,9 @@ export namespace networkservices_v1beta1 { this.httpRoutes = new Resource$Projects$Locations$Httproutes( this.context ); + this.lbEdgeExtensions = new Resource$Projects$Locations$Lbedgeextensions( + this.context + ); this.lbRouteExtensions = new Resource$Projects$Locations$Lbrouteextensions(this.context); this.lbTrafficExtensions = @@ -2301,6 +2399,10 @@ export namespace networkservices_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -3352,6 +3454,10 @@ export namespace networkservices_v1beta1 { * Required. The project and location from which the EndpointPolicies 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$Endpointpolicies$Patch extends StandardParameters { @@ -4592,6 +4698,10 @@ export namespace networkservices_v1beta1 { * Required. The project and location from which the GrpcRoutes 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$Grpcroutes$Patch extends StandardParameters { @@ -5102,6 +5212,10 @@ export namespace networkservices_v1beta1 { * Required. The project and location from which the HttpRoutes 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$Httproutes$Patch extends StandardParameters { @@ -5120,14 +5234,14 @@ export namespace networkservices_v1beta1 { requestBody?: Schema$HttpRoute; } - export class Resource$Projects$Locations$Lbrouteextensions { + export class Resource$Projects$Locations$Lbedgeextensions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbRouteExtension` resource in a given project and location. + * Creates a new `LbEdgeExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5135,31 +5249,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | Params$Resource$Projects$Locations$Lbedgeextensions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5172,13 +5286,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {} as Params$Resource$Projects$Locations$Lbedgeextensions$Create; options = {}; } @@ -5192,7 +5306,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbEdgeExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -5217,7 +5331,7 @@ export namespace networkservices_v1beta1 { } /** - * Deletes the specified `LbRouteExtension` resource. + * Deletes the specified `LbEdgeExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5225,31 +5339,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | Params$Resource$Projects$Locations$Lbedgeextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5262,13 +5376,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {} as Params$Resource$Projects$Locations$Lbedgeextensions$Delete; options = {}; } @@ -5304,7 +5418,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of the specified `LbRouteExtension` resource. + * Gets details of the specified `LbEdgeExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5312,49 +5426,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbedgeextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + params = {} as Params$Resource$Projects$Locations$Lbedgeextensions$Get; options = {}; } @@ -5380,17 +5494,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists `LbRouteExtension` resources in a given project and location. + * Lists `LbEdgeExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5398,57 +5512,56 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbedgeextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + params = {} as Params$Resource$Projects$Locations$Lbedgeextensions$List; options = {}; } @@ -5462,7 +5575,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbEdgeExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -5477,19 +5590,19 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of the specified `LbRouteExtension` resource. + * Updates the parameters of the specified `LbEdgeExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5497,31 +5610,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | Params$Resource$Projects$Locations$Lbedgeextensions$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5534,13 +5647,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {} as Params$Resource$Projects$Locations$Lbedgeextensions$Patch; options = {}; } @@ -5576,14 +5689,14 @@ export namespace networkservices_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Create extends StandardParameters { /** - * Required. User-provided ID of the `LbRouteExtension` resource to be created. + * Required. User-provided ID of the `LbEdgeExtension` resource to be created. */ - lbRouteExtensionId?: string; + lbEdgeExtensionId?: string; /** - * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * Required. The parent resource of the `LbEdgeExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. */ parent?: string; /** @@ -5594,12 +5707,12 @@ export namespace networkservices_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$LbEdgeExtension; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Delete extends StandardParameters { /** - * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. The name of the `LbEdgeExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. */ name?: string; /** @@ -5607,14 +5720,14 @@ export namespace networkservices_v1beta1 { */ requestId?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Get extends StandardParameters { /** - * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the `LbEdgeExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + export interface Params$Resource$Projects$Locations$Lbedgeextensions$List extends StandardParameters { /** * Optional. Filtering results. @@ -5633,14 +5746,14 @@ export namespace networkservices_v1beta1 { */ pageToken?: string; /** - * Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the `LbEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Patch extends StandardParameters { /** - * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. */ name?: string; /** @@ -5648,24 +5761,24 @@ export namespace networkservices_v1beta1 { */ requestId?: string; /** - * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Used to specify the fields to be overwritten in the `LbEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$LbEdgeExtension; } - export class Resource$Projects$Locations$Lbtrafficextensions { + export class Resource$Projects$Locations$Lbrouteextensions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbTrafficExtension` resource in a given project and location. + * Creates a new `LbRouteExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5673,31 +5786,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | Params$Resource$Projects$Locations$Lbrouteextensions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5710,13 +5823,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; options = {}; } @@ -5730,7 +5843,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -5755,7 +5868,7 @@ export namespace networkservices_v1beta1 { } /** - * Deletes the specified `LbTrafficExtension` resource. + * Deletes the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5763,31 +5876,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + | Params$Resource$Projects$Locations$Lbrouteextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5800,13 +5913,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; options = {}; } @@ -5842,7 +5955,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of the specified `LbTrafficExtension` resource. + * Gets details of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5850,53 +5963,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; options = {}; } @@ -5922,7 +6031,549 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `LbRouteExtension` resources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').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 the specified `LbRouteExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + extends StandardParameters { + /** + * Required. User-provided ID of the `LbRouteExtension` resource to be created. + */ + lbRouteExtensionId?: string; + /** + * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint about how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + extends StandardParameters { + /** + * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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; + /** + * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + + export class Resource$Projects$Locations$Lbtrafficextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new `LbTrafficExtension` resource in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').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 `LbTrafficExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of the specified `LbTrafficExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( parameters, callback as BodyResponseCallback ); @@ -8759,6 +9410,10 @@ export namespace networkservices_v1beta1 { * Required. The project and location from which the TcpRoutes 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$Tcproutes$Patch extends StandardParameters { @@ -9269,6 +9924,10 @@ export namespace networkservices_v1beta1 { * Required. The project and location from which the TlsRoutes 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$Tlsroutes$Patch extends StandardParameters { diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index 2a07fbab22c..5ae337280ef 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -209,6 +209,19 @@ export namespace notebooks_v2 { */ upgradeVersion?: string | null; } + /** + * A set of Confidential Instance options. + */ + export interface Schema$ConfidentialInstanceConfig { + /** + * Optional. Defines the type of technology used by the confidential instance. + */ + confidentialInstanceType?: string | null; + /** + * Optional. Defines whether the instance should have confidential compute enabled. + */ + enableConfidentialCompute?: boolean | null; + } /** * Response for getting WbI configurations in a location */ @@ -365,6 +378,10 @@ export namespace notebooks_v2 { * Optional. The boot disk for the VM. */ bootDisk?: Schema$BootDisk; + /** + * Optional. Confidential instance configuration. + */ + confidentialInstanceConfig?: Schema$ConfidentialInstanceConfig; /** * Optional. Use a container image to start the notebook instance. */ diff --git a/src/apis/observability/README.md b/src/apis/observability/README.md new file mode 100644 index 00000000000..ea41641e7e7 --- /dev/null +++ b/src/apis/observability/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# observability + +> + +## Installation + +```sh +$ npm install @googleapis/observability +``` + +## 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/observability/classes/Observability.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/observability/index.ts b/src/apis/observability/index.ts new file mode 100644 index 00000000000..e25262cc099 --- /dev/null +++ b/src/apis/observability/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 {observability_v1} from './v1'; + +export const VERSIONS = { + v1: observability_v1.Observability, +}; + +export function observability(version: 'v1'): observability_v1.Observability; +export function observability( + options: observability_v1.Options +): observability_v1.Observability; +export function observability( + this: GoogleConfigurable, + versionOrOptions: 'v1' | observability_v1.Options +) { + return getAPI('observability', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {observability_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/observability/package.json b/src/apis/observability/package.json new file mode 100644 index 00000000000..8a6585909fd --- /dev/null +++ b/src/apis/observability/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/observability", + "version": "0.1.0", + "description": "observability", + "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/observability/tsconfig.json b/src/apis/observability/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/observability/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/observability/v1.ts b/src/apis/observability/v1.ts new file mode 100644 index 00000000000..ca6f2d6d6ed --- /dev/null +++ b/src/apis/observability/v1.ts @@ -0,0 +1,1119 @@ +// 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 observability_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; + } + + /** + * Observability API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const observability = google.observability('v1'); + * ``` + */ + export class Observability { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$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; + } + /** + * Message describing Scope object + */ + export interface Schema$Scope { + /** + * Required. The full resource name of the `LogScope`. For example: //logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope + */ + logScope?: string | null; + /** + * Identifier. Name of the resource. The format is: projects/{project\}/locations/{location\}/scopes/{scope\} The `{location\}` field must be set to `global`. The `{scope\}` field must be set to `_Default`. + */ + name?: string | null; + /** + * Output only. Update timestamp. Note: The Update timestamp for the default scope is initially unset. + */ + updateTime?: 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; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + scopes: Resource$Projects$Locations$Scopes; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.scopes = new Resource$Projects$Locations$Scopes(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://observability.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://observability.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 { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.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://observability.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://observability.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://observability.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; + } + + export class Resource$Projects$Locations$Scopes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single Scope. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Scopes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Scopes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Scopes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Scopes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Scopes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Scopes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Scopes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Scopes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.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 parameters of a single 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. + */ + patch( + params: Params$Resource$Projects$Locations$Scopes$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Scopes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Scopes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Scopes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Scopes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Scopes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Scopes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Scopes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.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$Scopes$Get + extends StandardParameters { + /** + * Required. Name of the resource. The format is: projects/{project\}/locations/{location\}/scopes/{scope\} The `{location\}` field must be set to `global`. The `{scope\}` field must be set to `_Default`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Scopes$Patch + extends StandardParameters { + /** + * Identifier. Name of the resource. The format is: projects/{project\}/locations/{location\}/scopes/{scope\} The `{location\}` field must be set to `global`. The `{scope\}` field must be set to `_Default`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Scope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten when it is in the mask. If the user does not provide a mask, then all fields present in the request are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Scope; + } +} diff --git a/src/apis/observability/webpack.config.js b/src/apis/observability/webpack.config.js new file mode 100644 index 00000000000..2fec10efa15 --- /dev/null +++ b/src/apis/observability/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: 'Observability', + filename: 'observability.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index fb48464058b..ce522ef389a 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -257,7 +257,7 @@ export namespace ondemandscanning_v1 { } 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. + * 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. */ binaryVersion?: Schema$PackageVersion; /** @@ -881,7 +881,7 @@ 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. + * Details about the layer a package was found in. */ export interface Schema$LayerDetails { /** @@ -1170,7 +1170,7 @@ export namespace ondemandscanning_v1 { */ packageType?: string | null; /** - * CVEs that this package is no longer vulnerable to go/drydock-dd-custom-binary-scanning + * CVEs that this package is no longer vulnerable to */ patchedCve?: string[] | null; /** diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index c889360a3c1..c7c6efa2df8 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -253,7 +253,7 @@ export namespace ondemandscanning_v1beta1 { } 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. + * 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. */ binaryVersion?: Schema$PackageVersion; /** @@ -877,7 +877,7 @@ 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. + * Details about the layer a package was found in. */ export interface Schema$LayerDetails { /** @@ -1166,7 +1166,7 @@ export namespace ondemandscanning_v1beta1 { */ packageType?: string | null; /** - * CVEs that this package is no longer vulnerable to go/drydock-dd-custom-binary-scanning + * CVEs that this package is no longer vulnerable to */ patchedCve?: string[] | null; /** diff --git a/src/apis/oracledatabase/v1.ts b/src/apis/oracledatabase/v1.ts index 0089531cb12..d89726df689 100644 --- a/src/apis/oracledatabase/v1.ts +++ b/src/apis/oracledatabase/v1.ts @@ -161,6 +161,10 @@ export namespace oracledatabase_v1 { * Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. */ database?: string | null; + /** + * Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project\}/locations/{location\}`. + */ + disasterRecoverySupportedLocations?: string[] | null; /** * Optional. The display name for the Autonomous Database. The name does not have to be unique within your project. */ @@ -181,10 +185,18 @@ export namespace oracledatabase_v1 { * Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project\}/global/networks/{network\} */ network?: string | null; + /** + * Output only. The peer Autonomous Database names of the given Autonomous Database. + */ + peerAutonomousDatabases?: string[] | null; /** * Optional. The properties of the Autonomous Database. */ properties?: Schema$AutonomousDatabaseProperties; + /** + * Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation. + */ + sourceConfig?: Schema$SourceConfig; } /** * Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex @@ -404,6 +416,10 @@ export namespace oracledatabase_v1 { * Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes. */ allocatedStorageSizeTb?: number | null; + /** + * Optional. The list of allowlisted IP addresses for the Autonomous Database. + */ + allowlistedIps?: string[] | null; /** * Output only. The details for the Oracle APEX Application Development. */ @@ -452,6 +468,10 @@ export namespace oracledatabase_v1 { * Output only. The current state of database management for the Autonomous Database. */ databaseManagementState?: string | null; + /** + * Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database. + */ + dataGuardRoleChangedTime?: string | null; /** * Output only. The current state of the Data Safe registration for the Autonomous Database. */ @@ -476,6 +496,10 @@ export namespace oracledatabase_v1 { * Required. The workload type of the Autonomous Database. */ dbWorkload?: string | null; + /** + * Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database. + */ + disasterRecoveryRoleChangedTime?: string | null; /** * Output only. This field indicates the number of seconds of data loss during a Data Guard failover. */ @@ -749,6 +773,10 @@ export namespace oracledatabase_v1 { * Optional. The number of compute servers for the Exadata Infrastructure. */ computeCount?: number | null; + /** + * Output only. The compute model of the Exadata Infrastructure. + */ + computeModel?: string | null; /** * Output only. The number of enabled CPU cores. */ @@ -757,6 +785,10 @@ export namespace oracledatabase_v1 { * Optional. The list of customer contacts. */ customerContacts?: Schema$CustomerContact[]; + /** + * Output only. The database server type of the Exadata Infrastructure. + */ + databaseServerType?: string | null; /** * Output only. Size, in terabytes, of the DATA disk group. */ @@ -833,6 +865,10 @@ export namespace oracledatabase_v1 { * Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure. */ storageCount?: number | null; + /** + * Output only. The storage server type of the Exadata Infrastructure. + */ + storageServerType?: string | null; /** * Output only. The software version of the storage servers (cells) in the Exadata Infrastructure. */ @@ -847,11 +883,11 @@ export namespace oracledatabase_v1 { */ export interface Schema$CloudVmCluster { /** - * Required. CIDR range of the backup subnet. + * Optional. CIDR range of the backup subnet. */ backupSubnetCidr?: string | null; /** - * Required. Network settings. CIDR to use for cluster IP allocation. + * Optional. Network settings. CIDR to use for cluster IP allocation. */ cidr?: string | null; /** @@ -879,7 +915,7 @@ export namespace oracledatabase_v1 { */ name?: string | null; /** - * Required. The name of the VPC network. Format: projects/{project\}/global/networks/{network\} + * Optional. The name of the VPC network. Format: projects/{project\}/global/networks/{network\} */ network?: string | null; /** @@ -899,6 +935,10 @@ export namespace oracledatabase_v1 { * Output only. Compartment ID of cluster. */ compartmentId?: string | null; + /** + * Output only. The compute model of the VM Cluster. + */ + computeModel?: string | null; /** * Required. Number of enabled CPU cores. */ @@ -1652,6 +1692,19 @@ export namespace oracledatabase_v1 { */ stopTime?: Schema$TimeOfDay; } + /** + * The source configuration for the standby Autonomnous Database. + */ + export interface Schema$SourceConfig { + /** + * Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard. + */ + automaticBackupsReplicationEnabled?: boolean | null; + /** + * Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source. + */ + autonomousDatabase?: string | null; + } /** * The request for `AutonomousDatabase.Start`. */ @@ -1677,6 +1730,15 @@ export namespace oracledatabase_v1 { * The request for `AutonomousDatabase.Stop`. */ export interface Schema$StopAutonomousDatabaseRequest {} + /** + * The request for `AutonomousDatabase.Switchover`. + */ + export interface Schema$SwitchoverAutonomousDatabaseRequest { + /** + * Required. The peer database name to switch over to. + */ + peerAutonomousDatabase?: 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`. */ @@ -1956,6 +2018,10 @@ export namespace oracledatabase_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -3049,6 +3115,96 @@ export namespace oracledatabase_v1 { return createAPIRequest(parameters); } } + + /** + * Initiates a switchover of specified autonomous deatabase to the associated peer database. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: StreamMethodOptions + ): GaxiosPromise; + switchover( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options?: MethodOptions + ): GaxiosPromise; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + callback: BodyResponseCallback + ): void; + switchover(callback: BodyResponseCallback): void; + switchover( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Switchover + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:switchover').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$Autonomousdatabases$Create @@ -3172,6 +3328,18 @@ export namespace oracledatabase_v1 { */ requestBody?: Schema$StopAutonomousDatabaseRequest; } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Switchover + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SwitchoverAutonomousDatabaseRequest; + } export class Resource$Projects$Locations$Autonomousdbversions { context: APIRequestContext; diff --git a/src/apis/orgpolicy/v2.ts b/src/apis/orgpolicy/v2.ts index f1dcf7e98d8..9aa64dba9c4 100644 --- a/src/apis/orgpolicy/v2.ts +++ b/src/apis/orgpolicy/v2.ts @@ -161,6 +161,10 @@ export namespace orgpolicy_v2 { * The human readable name. Mutable. */ displayName?: string | null; + /** + * Managed constraint and canned constraint sometimes can have equivalents. This field is used to store the equivalent constraint name. + */ + equivalentConstraint?: string | null; /** * Defines this constraint as being a list constraint. */ diff --git a/src/apis/osconfig/index.ts b/src/apis/osconfig/index.ts index 938361f8443..1f014f3bd03 100644 --- a/src/apis/osconfig/index.ts +++ b/src/apis/osconfig/index.ts @@ -17,12 +17,14 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {osconfig_v1} from './v1'; import {osconfig_v1alpha} from './v1alpha'; import {osconfig_v1beta} from './v1beta'; +import {osconfig_v2} from './v2'; import {osconfig_v2beta} from './v2beta'; export const VERSIONS = { v1: osconfig_v1.Osconfig, v1alpha: osconfig_v1alpha.Osconfig, v1beta: osconfig_v1beta.Osconfig, + v2: osconfig_v2.Osconfig, v2beta: osconfig_v2beta.Osconfig, }; @@ -36,6 +38,8 @@ export function osconfig(version: 'v1beta'): osconfig_v1beta.Osconfig; export function osconfig( options: osconfig_v1beta.Options ): osconfig_v1beta.Osconfig; +export function osconfig(version: 'v2'): osconfig_v2.Osconfig; +export function osconfig(options: osconfig_v2.Options): osconfig_v2.Osconfig; export function osconfig(version: 'v2beta'): osconfig_v2beta.Osconfig; export function osconfig( options: osconfig_v2beta.Options @@ -45,6 +49,7 @@ export function osconfig< | osconfig_v1.Osconfig | osconfig_v1alpha.Osconfig | osconfig_v1beta.Osconfig + | osconfig_v2.Osconfig | osconfig_v2beta.Osconfig, >( this: GoogleConfigurable, @@ -55,6 +60,8 @@ export function osconfig< | osconfig_v1alpha.Options | 'v1beta' | osconfig_v1beta.Options + | 'v2' + | osconfig_v2.Options | 'v2beta' | osconfig_v2beta.Options ) { @@ -66,6 +73,7 @@ export {auth}; export {osconfig_v1}; export {osconfig_v1alpha}; export {osconfig_v1beta}; +export {osconfig_v2}; export {osconfig_v2beta}; export { AuthPlus, diff --git a/src/apis/osconfig/v1.ts b/src/apis/osconfig/v1.ts index baaf280a7f4..3a5af331d56 100644 --- a/src/apis/osconfig/v1.ts +++ b/src/apis/osconfig/v1.ts @@ -374,6 +374,39 @@ export namespace osconfig_v1 { */ verb?: string | null; } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudOsconfigV2__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; + } /** * Googet patching is performed by running `googet update`. */ diff --git a/src/apis/osconfig/v1alpha.ts b/src/apis/osconfig/v1alpha.ts index e3dd07a1a83..090696e8f20 100644 --- a/src/apis/osconfig/v1alpha.ts +++ b/src/apis/osconfig/v1alpha.ts @@ -269,6 +269,39 @@ export namespace osconfig_v1alpha { */ verb?: string | null; } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudOsconfigV2__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; + } /** * This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance). */ diff --git a/src/apis/osconfig/v1beta.ts b/src/apis/osconfig/v1beta.ts index 5024e635f32..9ab0948c61a 100644 --- a/src/apis/osconfig/v1beta.ts +++ b/src/apis/osconfig/v1beta.ts @@ -436,6 +436,39 @@ export namespace osconfig_v1beta { */ verb?: string | null; } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudOsconfigV2__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; + } /** * Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. */ diff --git a/src/apis/osconfig/v2.ts b/src/apis/osconfig/v2.ts new file mode 100644 index 00000000000..c66c73c1df4 --- /dev/null +++ b/src/apis/osconfig/v2.ts @@ -0,0 +1,3948 @@ +// 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 osconfig_v2 { + export interface Options extends GlobalOptions { + version: 'v2'; + } + + 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; + } + + /** + * OS Config API + * + * OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const osconfig = google.osconfig('v2'); + * ``` + */ + export class Osconfig { + context: APIRequestContext; + folders: Resource$Folders; + organizations: Resource$Organizations; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.folders = new Resource$Folders(this.context); + this.organizations = new Resource$Organizations(this.context); + this.projects = new Resource$Projects(this.context); + } + } + + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value. + */ + export interface Schema$FixedOrPercent { + /** + * Specifies a fixed value. + */ + fixed?: number | null; + /** + * Specifies the relative value defined as a percentage, which will be multiplied by a reference value. + */ + percent?: number | null; + } + /** + * OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations. + */ + export interface Schema$GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata { + /** + * The OS policy assignment API method. + */ + apiMethod?: string | null; + /** + * Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id@revision_id\}` + */ + osPolicyAssignment?: string | null; + /** + * Rollout start time + */ + rolloutStartTime?: string | null; + /** + * State of the rollout + */ + rolloutState?: string | null; + /** + * Rollout update time + */ + rolloutUpdateTime?: string | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudOsconfigV2beta__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; + } + /** + * Selector containing locations in scope. + */ + export interface Schema$GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector { + /** + * Optional. Names of the locations in scope. Format: `us-central1-a` + */ + includedLocations?: string[] | null; + } + /** + * Selector containing Cloud Resource Manager resource hierarchy nodes. + */ + export interface Schema$GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector { + /** + * Optional. Names of the folders in scope. Format: `folders/{folder_id\}` + */ + includedFolders?: string[] | null; + /** + * Optional. Names of the projects in scope. Format: `projects/{project_number\}` + */ + includedProjects?: string[] | null; + } + /** + * Selector for the resources in scope of orchestration. + */ + export interface Schema$GoogleCloudOsconfigV2_OrchestrationScope_Selector { + /** + * Selector for selecting locations. + */ + locationSelector?: Schema$GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector; + /** + * Selector for selecting resource hierarchy. + */ + resourceHierarchySelector?: Schema$GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector; + } + /** + * Describes the state of a single iteration of the orchestrator. + */ + export interface Schema$GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState { + /** + * Output only. Error thrown in the wave iteration. + */ + error?: Schema$Status; + /** + * Output only. Number of orchestration actions which failed so far. For more details, query the Cloud Logs. + */ + failedActions?: string | null; + /** + * Output only. Finish time of the wave iteration. + */ + finishTime?: string | null; + /** + * Output only. Unique identifier of the iteration. + */ + iterationId?: string | null; + /** + * Output only. Overall number of actions done by the orchestrator so far. + */ + performedActions?: string | null; + /** + * Output only. An estimated percentage of the progress. Number between 0 and 100. + */ + progress?: number | null; + /** + * Output only. Start time of the wave iteration. + */ + startTime?: string | null; + /** + * Output only. State of the iteration. + */ + state?: string | null; + } + /** + * Describes the state of the orchestration process. + */ + export interface Schema$GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState { + /** + * Output only. Current Wave iteration state. + */ + currentIterationState?: Schema$GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState; + /** + * Output only. Previous Wave iteration state. + */ + previousIterationState?: Schema$GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState; + } + /** + * Response for the list policy orchestrator resources. + */ + export interface Schema$GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The policy orchestrators for the specified parent resource. + */ + policyOrchestrators?: Schema$GoogleCloudOsconfigV2__PolicyOrchestrator[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudOsconfigV2__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; + } + /** + * Represents a resource that is being orchestrated by the policy orchestrator. + */ + export interface Schema$GoogleCloudOsconfigV2__OrchestratedResource { + /** + * Optional. ID of the resource to be used while generating set of affected resources. For UPSERT action the value is auto-generated during PolicyOrchestrator creation when not set. When the value is set it should following next restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. For DELETE action, ID must be specified explicitly during PolicyOrchestrator creation. + */ + id?: string | null; + /** + * Optional. OSPolicyAssignment resource to be created, updated or deleted. Name field is ignored and replace with a generated value. With this field set, orchestrator will perform actions on `project/{project\}/locations/{zone\}/osPolicyAssignments/{resource_id\}` resources, where `project` and `zone` pairs come from the expanded scope, and `resource_id` comes from the `resource_id` field of orchestrator resource. + */ + osPolicyAssignmentV1Payload?: Schema$OSPolicyAssignment; + } + /** + * Defines a set of selectors which drive which resources are in scope of policy orchestration. + */ + export interface Schema$GoogleCloudOsconfigV2__OrchestrationScope { + /** + * Optional. Selectors of the orchestration scope. There is a logical AND between each selector defined. When there is no explicit `ResourceHierarchySelector` selector specified, the scope is by default bounded to the parent of the policy orchestrator resource. + */ + selectors?: Schema$GoogleCloudOsconfigV2_OrchestrationScope_Selector[]; + } + /** + * PolicyOrchestrator helps managing project+zone level policy resources (e.g. OS Policy Assignments), by providing tools to create, update and delete them across projects and locations, at scale. Policy orchestrator functions as an endless loop. Each iteration orchestrator computes a set of resources that should be affected, then progressively applies changes to them. If for some reason this set of resources changes over time (e.g. new projects are added), the future loop iterations will address that. Orchestrator can either upsert or delete policy resources. For more details, see the description of the `action`, and `orchestrated_resource` fields. Note that policy orchestrator do not "manage" the resources it creates. Every iteration is independent and only minimal history of past actions is retained (apart from Cloud Logging). If orchestrator gets deleted, it does not affect the resources it created in the past. Those will remain where they were. Same applies if projects are removed from the orchestrator's scope. + */ + export interface Schema$GoogleCloudOsconfigV2__PolicyOrchestrator { + /** + * Required. Action to be done by the orchestrator in `projects/{project_id\}/zones/{zone_id\}` locations defined by the `orchestration_scope`. Allowed values: - `UPSERT` - Orchestrator will create or update target resources. - `DELETE` - Orchestrator will delete target resources, if they exist + */ + action?: string | null; + /** + * Output only. Timestamp when the policy orchestrator resource was created. + */ + createTime?: string | null; + /** + * Optional. Freeform text describing the purpose of the resource. + */ + description?: string | null; + /** + * Output only. 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. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. Identifier. In form of * `organizations/{organization_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `folders/{folder_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `projects/{project_id_or_number\}/locations/global/policyOrchestrators/{orchestrator_id\}` + */ + name?: string | null; + /** + * Required. Resource to be orchestrated by the policy orchestrator. + */ + orchestratedResource?: Schema$GoogleCloudOsconfigV2__OrchestratedResource; + /** + * Optional. Defines scope for the orchestration, in context of the enclosing PolicyOrchestrator resource. Scope is expanded into a list of pairs, in which the rollout action will take place. Expansion starts with a Folder resource parenting the PolicyOrchestrator resource: - All the descendant projects are listed. - List of project is cross joined with a list of all available zones. - Resulting list of pairs is filtered according to the selectors. + */ + orchestrationScope?: Schema$GoogleCloudOsconfigV2__OrchestrationScope; + /** + * Output only. State of the orchestration. + */ + orchestrationState?: Schema$GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState; + /** + * Output only. Set to true, if the there are ongoing changes being applied by the orchestrator. + */ + reconciling?: boolean | null; + /** + * Optional. State of the orchestrator. Can be updated to change orchestrator behaviour. Allowed values: - `ACTIVE` - orchestrator is actively looking for actions to be taken. - `STOPPED` - orchestrator won't make any changes. Note: There might be more states added in the future. We use string here instead of an enum, to avoid the need of propagating new states to all the client code. + */ + state?: string | null; + /** + * Output only. Timestamp when the policy orchestrator resource was last modified. + */ + updateTime?: 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[]; + } + /** + * 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; + } + /** + * An OS policy defines the desired state configuration for a VM. + */ + export interface Schema$OSPolicy { + /** + * This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce. + */ + allowNoResourceGroupMatch?: boolean | null; + /** + * Policy description. Length of the description is limited to 1024 characters. + */ + description?: string | null; + /** + * Required. The id of the OS policy with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the assignment. + */ + id?: string | null; + /** + * Required. Policy mode + */ + mode?: string | null; + /** + * Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match` + */ + resourceGroups?: Schema$OSPolicyResourceGroup[]; + } + /** + * OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information about the OS policy resource definitions and examples, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies). + */ + export interface Schema$OSPolicyAssignment { + /** + * Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. + */ + baseline?: boolean | null; + /** + * Output only. Indicates that this revision deletes the OS policy assignment. + */ + deleted?: boolean | null; + /** + * OS policy assignment description. Length of the description is limited to 1024 characters. + */ + description?: string | null; + /** + * The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. + */ + etag?: string | null; + /** + * Required. Filter to select VMs. + */ + instanceFilter?: Schema$OSPolicyAssignmentInstanceFilter; + /** + * Resource name. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id\}` This field is ignored when you create an OS policy assignment. + */ + name?: string | null; + /** + * Required. List of OS policies to be applied to the VMs. + */ + osPolicies?: Schema$OSPolicy[]; + /** + * Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING + */ + reconciling?: boolean | null; + /** + * Output only. The timestamp that the revision was created. + */ + revisionCreateTime?: string | null; + /** + * Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment + */ + revisionId?: string | null; + /** + * Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted. + */ + rollout?: Schema$OSPolicyAssignmentRollout; + /** + * Output only. OS policy assignment rollout state + */ + rolloutState?: string | null; + /** + * Output only. Server generated unique id for the OS policy assignment resource. + */ + uid?: string | null; + } + /** + * Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. + */ + export interface Schema$OSPolicyAssignmentInstanceFilter { + /** + * Target all VMs in the project. If true, no other criteria is permitted. + */ + all?: boolean | null; + /** + * List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. + */ + exclusionLabels?: Schema$OSPolicyAssignmentLabelSet[]; + /** + * List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM. + */ + inclusionLabels?: Schema$OSPolicyAssignmentLabelSet[]; + /** + * List of inventories to select VMs. A VM is selected if its inventory data matches at least one of the following inventories. + */ + inventories?: Schema$OSPolicyAssignmentInstanceFilterInventory[]; + } + /** + * VM inventory details. + */ + export interface Schema$OSPolicyAssignmentInstanceFilterInventory { + /** + * Required. The OS short name + */ + osShortName?: string | null; + /** + * The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` An empty string matches all OS versions. + */ + osVersion?: string | null; + } + /** + * Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present. + */ + export interface Schema$OSPolicyAssignmentLabelSet { + /** + * Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. + */ + labels?: {[key: string]: string} | null; + } + /** + * OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations. + */ + export interface Schema$OSPolicyAssignmentOperationMetadata { + /** + * The OS policy assignment API method. + */ + apiMethod?: string | null; + /** + * Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id@revision_id\}` + */ + osPolicyAssignment?: string | null; + /** + * Rollout start time + */ + rolloutStartTime?: string | null; + /** + * State of the rollout + */ + rolloutState?: string | null; + /** + * Rollout update time + */ + rolloutUpdateTime?: string | null; + } + /** + * Message to configure the rollout at the zonal level for the OS policy assignment. + */ + export interface Schema$OSPolicyAssignmentRollout { + /** + * Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment. + */ + disruptionBudget?: Schema$FixedOrPercent; + /** + * Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied. + */ + minWaitDuration?: string | null; + } + /** + * Filtering criteria to select VMs based on inventory details. + */ + export interface Schema$OSPolicyInventoryFilter { + /** + * Required. The OS short name + */ + osShortName?: string | null; + /** + * The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*` An empty string matches all OS versions. + */ + osVersion?: string | null; + } + /** + * An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state. + */ + export interface Schema$OSPolicyResource { + /** + * Exec resource + */ + exec?: Schema$OSPolicyResourceExecResource; + /** + * File resource + */ + file?: Schema$OSPolicyResourceFileResource; + /** + * Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the OS policy. + */ + id?: string | null; + /** + * Package resource + */ + pkg?: Schema$OSPolicyResourcePackageResource; + /** + * Package repository resource + */ + repository?: Schema$OSPolicyResourceRepositoryResource; + } + /** + * A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen. + */ + export interface Schema$OSPolicyResourceExecResource { + /** + * What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce. + */ + enforce?: Schema$OSPolicyResourceExecResourceExec; + /** + * Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. + */ + validate?: Schema$OSPolicyResourceExecResourceExec; + } + /** + * A file or script to execute. + */ + export interface Schema$OSPolicyResourceExecResourceExec { + /** + * Optional arguments to pass to the source during execution. + */ + args?: string[] | null; + /** + * A remote or local file. + */ + file?: Schema$OSPolicyResourceFile; + /** + * Required. The script interpreter to use. + */ + interpreter?: string | null; + /** + * Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. + */ + outputFilePath?: string | null; + /** + * An inline script. The size of the script is limited to 32KiB. + */ + script?: string | null; + } + /** + * A remote or local file. + */ + export interface Schema$OSPolicyResourceFile { + /** + * Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified. + */ + allowInsecure?: boolean | null; + /** + * A Cloud Storage object. + */ + gcs?: Schema$OSPolicyResourceFileGcs; + /** + * A local path within the VM to use. + */ + localPath?: string | null; + /** + * A generic remote file. + */ + remote?: Schema$OSPolicyResourceFileRemote; + } + /** + * Specifies a file available as a Cloud Storage Object. + */ + export interface Schema$OSPolicyResourceFileGcs { + /** + * Required. Bucket of the Cloud Storage object. + */ + bucket?: string | null; + /** + * Generation number of the Cloud Storage object. + */ + generation?: string | null; + /** + * Required. Name of the Cloud Storage object. + */ + object?: string | null; + } + /** + * Specifies a file available via some URI. + */ + export interface Schema$OSPolicyResourceFileRemote { + /** + * SHA256 checksum of the remote file. + */ + sha256Checksum?: string | null; + /** + * Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol\}://{location\}`. + */ + uri?: string | null; + } + /** + * A resource that manages the state of a file. + */ + export interface Schema$OSPolicyResourceFileResource { + /** + * A a file with this content. The size of the content is limited to 32KiB. + */ + content?: string | null; + /** + * A remote or local source. + */ + file?: Schema$OSPolicyResourceFile; + /** + * Required. The absolute path of the file within the VM. + */ + path?: string | null; + /** + * Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 + */ + permissions?: string | null; + /** + * Required. Desired state of the file. + */ + state?: string | null; + } + /** + * Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group. + */ + export interface Schema$OSPolicyResourceGroup { + /** + * List of inventory filters for the resource group. The resources in this resource group are applied to the target VM if it satisfies at least one of the following inventory filters. For example, to apply this resource group to VMs running either `RHEL` or `CentOS` operating systems, specify 2 items for the list with following values: inventory_filters[0].os_short_name='rhel' and inventory_filters[1].os_short_name='centos' If the list is empty, this resource group will be applied to the target VM unconditionally. + */ + inventoryFilters?: Schema$OSPolicyInventoryFilter[]; + /** + * Required. List of resources configured for this resource group. The resources are executed in the exact order specified here. + */ + resources?: Schema$OSPolicyResource[]; + } + /** + * A resource that manages a system package. + */ + export interface Schema$OSPolicyResourcePackageResource { + /** + * A package managed by Apt. + */ + apt?: Schema$OSPolicyResourcePackageResourceAPT; + /** + * A deb package file. + */ + deb?: Schema$OSPolicyResourcePackageResourceDeb; + /** + * Required. The desired state the agent should maintain for this package. + */ + desiredState?: string | null; + /** + * A package managed by GooGet. + */ + googet?: Schema$OSPolicyResourcePackageResourceGooGet; + /** + * An MSI package. + */ + msi?: Schema$OSPolicyResourcePackageResourceMSI; + /** + * An rpm package file. + */ + rpm?: Schema$OSPolicyResourcePackageResourceRPM; + /** + * A package managed by YUM. + */ + yum?: Schema$OSPolicyResourcePackageResourceYUM; + /** + * A package managed by Zypper. + */ + zypper?: Schema$OSPolicyResourcePackageResourceZypper; + } + /** + * A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]` + */ + export interface Schema$OSPolicyResourcePackageResourceAPT { + /** + * Required. Package name. + */ + name?: string | null; + } + /** + * A deb package file. dpkg packages only support INSTALLED state. + */ + export interface Schema$OSPolicyResourcePackageResourceDeb { + /** + * Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb` + */ + pullDeps?: boolean | null; + /** + * Required. A deb package. + */ + source?: Schema$OSPolicyResourceFile; + } + /** + * A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package` + */ + export interface Schema$OSPolicyResourcePackageResourceGooGet { + /** + * Required. Package name. + */ + name?: string | null; + } + /** + * An MSI package. MSI packages only support INSTALLED state. + */ + export interface Schema$OSPolicyResourcePackageResourceMSI { + /** + * Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`. + */ + properties?: string[] | null; + /** + * Required. The MSI package. + */ + source?: Schema$OSPolicyResourceFile; + } + /** + * An RPM package file. RPM packages only support INSTALLED state. + */ + export interface Schema$OSPolicyResourcePackageResourceRPM { + /** + * Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm` + */ + pullDeps?: boolean | null; + /** + * Required. An rpm package. + */ + source?: Schema$OSPolicyResourceFile; + } + /** + * A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package` + */ + export interface Schema$OSPolicyResourcePackageResourceYUM { + /** + * Required. Package name. + */ + name?: string | null; + } + /** + * A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package` + */ + export interface Schema$OSPolicyResourcePackageResourceZypper { + /** + * Required. Package name. + */ + name?: string | null; + } + /** + * A resource that manages a package repository. + */ + export interface Schema$OSPolicyResourceRepositoryResource { + /** + * An Apt Repository. + */ + apt?: Schema$OSPolicyResourceRepositoryResourceAptRepository; + /** + * A Goo Repository. + */ + goo?: Schema$OSPolicyResourceRepositoryResourceGooRepository; + /** + * A Yum Repository. + */ + yum?: Schema$OSPolicyResourceRepositoryResourceYumRepository; + /** + * A Zypper Repository. + */ + zypper?: Schema$OSPolicyResourceRepositoryResourceZypperRepository; + } + /** + * Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`. + */ + export interface Schema$OSPolicyResourceRepositoryResourceAptRepository { + /** + * Required. Type of archive files in this repository. + */ + archiveType?: string | null; + /** + * Required. List of components for this repository. Must contain at least one item. + */ + components?: string[] | null; + /** + * Required. Distribution of this repository. + */ + distribution?: string | null; + /** + * URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`. + */ + gpgKey?: string | null; + /** + * Required. URI for this repository. + */ + uri?: string | null; + } + /** + * Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`. + */ + export interface Schema$OSPolicyResourceRepositoryResourceGooRepository { + /** + * Required. The name of the repository. + */ + name?: string | null; + /** + * Required. The url of the repository. + */ + url?: string | null; + } + /** + * Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`. + */ + export interface Schema$OSPolicyResourceRepositoryResourceYumRepository { + /** + * Required. The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * Required. A one word, unique name for this repository. This is the `repo id` in the yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for resource conflicts. + */ + id?: string | null; + } + /** + * Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`. + */ + export interface Schema$OSPolicyResourceRepositoryResourceZypperRepository { + /** + * Required. The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for GuestPolicy conflicts. + */ + id?: 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; + } + + export class Resource$Folders { + context: APIRequestContext; + locations: Resource$Folders$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Folders$Locations(this.context); + } + } + + export class Resource$Folders$Locations { + context: APIRequestContext; + global: Resource$Folders$Locations$Global; + operations: Resource$Folders$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.global = new Resource$Folders$Locations$Global(this.context); + this.operations = new Resource$Folders$Locations$Operations(this.context); + } + } + + export class Resource$Folders$Locations$Global { + context: APIRequestContext; + policyOrchestrators: Resource$Folders$Locations$Global$Policyorchestrators; + constructor(context: APIRequestContext) { + this.context = context; + this.policyOrchestrators = + new Resource$Folders$Locations$Global$Policyorchestrators(this.context); + } + } + + export class Resource$Folders$Locations$Global$Policyorchestrators { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new policy orchestrator under the given folder resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Folders$Locations$Global$Policyorchestrators$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Folders$Locations$Global$Policyorchestrators$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Global$Policyorchestrators$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Global$Policyorchestrators$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Folders$Locations$Global$Policyorchestrators$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/policyOrchestrators').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 existing policy orchestrator resource, parented by a folder. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Folders$Locations$Global$Policyorchestrators$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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); + } + } + + /** + * Retrieves an existing policy orchestrator, parented by a folder. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Folders$Locations$Global$Policyorchestrators$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Folders$Locations$Global$Policyorchestrators$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Global$Policyorchestrators$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Global$Policyorchestrators$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Folders$Locations$Global$Policyorchestrators$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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 the policy orchestrators under the given parent folder resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Folders$Locations$Global$Policyorchestrators$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Global$Policyorchestrators$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Global$Policyorchestrators$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Folders$Locations$Global$Policyorchestrators$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/policyOrchestrators').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing policy orchestrator, parented by a folder. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Folders$Locations$Global$Policyorchestrators$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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); + } + } + } + + export interface Params$Resource$Folders$Locations$Global$Policyorchestrators$Create + extends StandardParameters { + /** + * Required. The parent resource name in the form of: * `organizations/{organization_id\}/locations/global` * `folders/{folder_id\}/locations/global` * `projects/{project_id_or_number\}/locations/global` + */ + parent?: string; + /** + * Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent. + */ + policyOrchestratorId?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsconfigV2__PolicyOrchestrator; + } + export interface Params$Resource$Folders$Locations$Global$Policyorchestrators$Delete + extends StandardParameters { + /** + * Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned. + */ + etag?: string; + /** + * Required. Name of the resource to be deleted. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Folders$Locations$Global$Policyorchestrators$Get + extends StandardParameters { + /** + * Required. The resource name. + */ + name?: string; + } + export interface Params$Resource$Folders$Locations$Global$Policyorchestrators$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 parent resource name. + */ + parent?: string; + } + export interface Params$Resource$Folders$Locations$Global$Policyorchestrators$Patch + extends StandardParameters { + /** + * Immutable. Identifier. In form of * `organizations/{organization_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `folders/{folder_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `projects/{project_id_or_number\}/locations/global/policyOrchestrators/{orchestrator_id\}` + */ + name?: string; + /** + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsconfigV2__PolicyOrchestrator; + } + + export class Resource$Folders$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$Folders$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Folders$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Folders$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Folders$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Folders$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Folders$Locations$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Folders$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Folders$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Folders$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Folders$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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 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$Folders$Locations$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Folders$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Folders$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Folders$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Folders$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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 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$Folders$Locations$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Folders$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Folders$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Folders$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Folders$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Folders$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$Folders$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Folders$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Folders$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$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; + operations: Resource$Organizations$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.global = new Resource$Organizations$Locations$Global(this.context); + this.operations = new Resource$Organizations$Locations$Operations( + this.context + ); + } + } + + export class Resource$Organizations$Locations$Global { + context: APIRequestContext; + policyOrchestrators: Resource$Organizations$Locations$Global$Policyorchestrators; + constructor(context: APIRequestContext) { + this.context = context; + this.policyOrchestrators = + new Resource$Organizations$Locations$Global$Policyorchestrators( + this.context + ); + } + } + + export class Resource$Organizations$Locations$Global$Policyorchestrators { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new policy orchestrator under the given organizations resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Global$Policyorchestrators$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/policyOrchestrators').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 existing policy orchestrator resource, parented by an organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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); + } + } + + /** + * Retrieves an existing policy orchestrator, parented by an organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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 the policy orchestrators under the given parent organization resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Global$Policyorchestrators$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Policyorchestrators$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Policyorchestrators$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Policyorchestrators$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/policyOrchestrators').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing policy orchestrator, parented by an organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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); + } + } + } + + export interface Params$Resource$Organizations$Locations$Global$Policyorchestrators$Create + extends StandardParameters { + /** + * Required. The parent resource name in the form of: * `organizations/{organization_id\}/locations/global` * `folders/{folder_id\}/locations/global` * `projects/{project_id_or_number\}/locations/global` + */ + parent?: string; + /** + * Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent. + */ + policyOrchestratorId?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsconfigV2__PolicyOrchestrator; + } + export interface Params$Resource$Organizations$Locations$Global$Policyorchestrators$Delete + extends StandardParameters { + /** + * Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned. + */ + etag?: string; + /** + * Required. Name of the resource to be deleted. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Organizations$Locations$Global$Policyorchestrators$Get + extends StandardParameters { + /** + * Required. The resource name. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Global$Policyorchestrators$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 parent resource name. + */ + parent?: string; + } + export interface Params$Resource$Organizations$Locations$Global$Policyorchestrators$Patch + extends StandardParameters { + /** + * Immutable. Identifier. In form of * `organizations/{organization_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `folders/{folder_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `projects/{project_id_or_number\}/locations/global/policyOrchestrators/{orchestrator_id\}` + */ + name?: string; + /** + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsconfigV2__PolicyOrchestrator; + } + + export class Resource$Organizations$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$Organizations$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Organizations$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Organizations$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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 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$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Organizations$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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 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$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$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$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects { + 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; + global: Resource$Projects$Locations$Global; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.global = new Resource$Projects$Locations$Global(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Global { + context: APIRequestContext; + policyOrchestrators: Resource$Projects$Locations$Global$Policyorchestrators; + constructor(context: APIRequestContext) { + this.context = context; + this.policyOrchestrators = + new Resource$Projects$Locations$Global$Policyorchestrators( + this.context + ); + } + } + + export class Resource$Projects$Locations$Global$Policyorchestrators { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new policy orchestrator under the given project resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Global$Policyorchestrators$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Global$Policyorchestrators$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Policyorchestrators$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Policyorchestrators$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Policyorchestrators$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/policyOrchestrators').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 existing policy orchestrator resource, parented by a project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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); + } + } + + /** + * Retrieves an existing policy orchestrator, parented by a 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$Projects$Locations$Global$Policyorchestrators$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Global$Policyorchestrators$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Policyorchestrators$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Policyorchestrators$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Policyorchestrators$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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 the policy orchestrators under the given parent project resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Global$Policyorchestrators$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Policyorchestrators$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Policyorchestrators$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Policyorchestrators$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/policyOrchestrators').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing policy orchestrator, parented by a 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. + */ + patch( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.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); + } + } + } + + export interface Params$Resource$Projects$Locations$Global$Policyorchestrators$Create + extends StandardParameters { + /** + * Required. The parent resource name in the form of: * `organizations/{organization_id\}/locations/global` * `folders/{folder_id\}/locations/global` * `projects/{project_id_or_number\}/locations/global` + */ + parent?: string; + /** + * Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent. + */ + policyOrchestratorId?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsconfigV2__PolicyOrchestrator; + } + export interface Params$Resource$Projects$Locations$Global$Policyorchestrators$Delete + extends StandardParameters { + /** + * Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned. + */ + etag?: string; + /** + * Required. Name of the resource to be deleted. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Global$Policyorchestrators$Get + extends StandardParameters { + /** + * Required. The resource name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Global$Policyorchestrators$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 parent resource name. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Global$Policyorchestrators$Patch + extends StandardParameters { + /** + * Immutable. Identifier. In form of * `organizations/{organization_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `folders/{folder_id\}/locations/global/policyOrchestrators/{orchestrator_id\}` * `projects/{project_id_or_number\}/locations/global/policyOrchestrators/{orchestrator_id\}` + */ + name?: string; + /** + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsconfigV2__PolicyOrchestrator; + } + + 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://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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://osconfig.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 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://osconfig.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 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://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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/osconfig/v2beta.ts b/src/apis/osconfig/v2beta.ts index 8b11a92fe95..3cf6502391c 100644 --- a/src/apis/osconfig/v2beta.ts +++ b/src/apis/osconfig/v2beta.ts @@ -225,6 +225,10 @@ export namespace osconfig_v2beta { * Output only. Finish time of the wave iteration. */ finishTime?: string | null; + /** + * Output only. Unique identifier of the iteration. + */ + iterationId?: string | null; /** * Output only. Overall number of actions done by the orchestrator so far. */ @@ -233,10 +237,6 @@ export namespace osconfig_v2beta { * Output only. An estimated percentage of the progress. Number between 0 and 100. */ progress?: number | null; - /** - * Output only. Handle to the Progressive Rollouts API rollout resource, which contains detailed information about a particular orchestration iteration. - */ - rolloutResource?: string | null; /** * Output only. Start time of the wave iteration. */ @@ -384,6 +384,39 @@ export namespace osconfig_v2beta { */ updateTime?: string | null; } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudOsconfigV2__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; + } /** * The response message for Operations.ListOperations. */ @@ -1544,7 +1577,7 @@ export namespace osconfig_v2beta { */ name?: string; /** - * Optional. The list of fields to update. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; @@ -2525,7 +2558,7 @@ export namespace osconfig_v2beta { */ name?: string; /** - * Optional. The list of fields to update. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; @@ -3508,7 +3541,7 @@ export namespace osconfig_v2beta { */ name?: string; /** - * Optional. The list of fields to update. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index b6edc8224ff..5de5c266703 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -139,11 +139,11 @@ export namespace oslogin_v1alpha { */ appEngineInstance?: string | null; /** - * The compute instance to sign the SSH public key for. Expected format: projects/{project\}/zones/{zone\}/instances/{numeric_instance_id\} + * 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 + * Optional. The service account for the 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. */ serviceAccount?: string | null; /** diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 38d4976badb..44bc73b3b04 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -139,11 +139,11 @@ export namespace oslogin_v1beta { */ appEngineInstance?: string | null; /** - * The compute instance to sign the SSH public key for. Expected format: projects/{project\}/zones/{zone\}/instances/{numeric_instance_id\} + * 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 + * Optional. The service account for the 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. */ serviceAccount?: string | null; /** diff --git a/src/apis/parallelstore/v1.ts b/src/apis/parallelstore/v1.ts index 06f54a3157e..3d9344eab63 100644 --- a/src/apis/parallelstore/v1.ts +++ b/src/apis/parallelstore/v1.ts @@ -159,7 +159,7 @@ export namespace parallelstore_v1 { */ 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). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** @@ -188,7 +188,7 @@ export namespace parallelstore_v1 { */ 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). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** @@ -217,7 +217,7 @@ export namespace parallelstore_v1 { */ createTime?: string | null; /** - * Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. + * Output only. Deprecated: The version of DAOS software running in the instance. */ daosVersion?: string | null; /** @@ -668,6 +668,10 @@ export namespace parallelstore_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -1323,7 +1327,7 @@ export namespace parallelstore_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 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). + * 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; @@ -1339,7 +1343,7 @@ export namespace parallelstore_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 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 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). + * 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; } @@ -1404,7 +1408,7 @@ export namespace parallelstore_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 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). + * 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; /** diff --git a/src/apis/parallelstore/v1beta.ts b/src/apis/parallelstore/v1beta.ts index 09dae764217..35340f5b1a0 100644 --- a/src/apis/parallelstore/v1beta.ts +++ b/src/apis/parallelstore/v1beta.ts @@ -155,7 +155,7 @@ export namespace parallelstore_v1beta { */ 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). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** @@ -184,7 +184,7 @@ export namespace parallelstore_v1beta { */ 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). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** @@ -213,7 +213,7 @@ export namespace parallelstore_v1beta { */ createTime?: string | null; /** - * Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. + * Output only. Deprecated: The version of DAOS software running in the instance. */ daosVersion?: string | null; /** @@ -664,6 +664,10 @@ export namespace parallelstore_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -1319,7 +1323,7 @@ export namespace parallelstore_v1beta { */ parent?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * 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; @@ -1335,7 +1339,7 @@ export namespace parallelstore_v1beta { */ 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 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). + * 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; } @@ -1400,7 +1404,7 @@ export namespace parallelstore_v1beta { */ 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 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). + * 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; /** diff --git a/src/apis/paymentsresellersubscription/v1.ts b/src/apis/paymentsresellersubscription/v1.ts index 9d01d98ad15..4bd22faca3a 100644 --- a/src/apis/paymentsresellersubscription/v1.ts +++ b/src/apis/paymentsresellersubscription/v1.ts @@ -562,6 +562,19 @@ export namespace paymentsresellersubscription_v1 { */ regionCode?: string | null; } + /** + * Request to resume a suspended subscription. + */ + export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest {} + /** + * Response that contains the resumed subscription. + */ + export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse { + /** + * The resumed subscription resource. + */ + subscription?: Schema$GoogleCloudPaymentsResellerSubscriptionV1Subscription; + } /** * A description of what time period or moment in time the product or service is being delivered over. */ @@ -787,6 +800,19 @@ export namespace paymentsresellersubscription_v1 { */ previousSubscriptionId?: string | null; } + /** + * Request to suspend a subscription. + */ + export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest {} + /** + * Response that contains the suspended subscription. + */ + export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse { + /** + * The suspended subscription resource. + */ + subscription?: Schema$GoogleCloudPaymentsResellerSubscriptionV1Subscription; + } /** * Request to revoke a cancellation request. */ @@ -1835,6 +1861,201 @@ export namespace paymentsresellersubscription_v1 { } } + /** + * Resumes a suspended subscription. The new billing cycle will start at the time of the request. 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`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resume( + params: Params$Resource$Partners$Subscriptions$Resume, + options: StreamMethodOptions + ): GaxiosPromise; + resume( + params?: Params$Resource$Partners$Subscriptions$Resume, + options?: MethodOptions + ): GaxiosPromise; + resume( + params: Params$Resource$Partners$Subscriptions$Resume, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Partners$Subscriptions$Resume, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Partners$Subscriptions$Resume, + callback: BodyResponseCallback + ): void; + resume( + callback: BodyResponseCallback + ): void; + resume( + paramsOrCallback?: + | Params$Resource$Partners$Subscriptions$Resume + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Subscriptions$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Subscriptions$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://paymentsresellersubscription.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Suspends a subscription. Contract terms may dictate if a prorated refund will be issued upon suspension. 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`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + suspend( + params: Params$Resource$Partners$Subscriptions$Suspend, + options: StreamMethodOptions + ): GaxiosPromise; + suspend( + params?: Params$Resource$Partners$Subscriptions$Suspend, + options?: MethodOptions + ): GaxiosPromise; + suspend( + params: Params$Resource$Partners$Subscriptions$Suspend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspend( + params: Params$Resource$Partners$Subscriptions$Suspend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspend( + params: Params$Resource$Partners$Subscriptions$Suspend, + callback: BodyResponseCallback + ): void; + suspend( + callback: BodyResponseCallback + ): void; + suspend( + paramsOrCallback?: + | Params$Resource$Partners$Subscriptions$Suspend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Subscriptions$Suspend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Subscriptions$Suspend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://paymentsresellersubscription.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:suspend').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 + ); + } + } + /** * 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. * @@ -2010,6 +2231,30 @@ export namespace paymentsresellersubscription_v1 { */ requestBody?: Schema$GoogleCloudPaymentsResellerSubscriptionV1Subscription; } + export interface Params$Resource$Partners$Subscriptions$Resume + extends StandardParameters { + /** + * Required. The name of the subscription resource to be resumed. It will have the format of "partners/{partner_id\}/subscriptions/{subscription_id\}" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest; + } + export interface Params$Resource$Partners$Subscriptions$Suspend + extends StandardParameters { + /** + * Required. The name of the subscription resource to be suspended. It will have the format of "partners/{partner_id\}/subscriptions/{subscription_id\}" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest; + } export interface Params$Resource$Partners$Subscriptions$Undocancel extends StandardParameters { /** diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index 1cb1746a732..98aed81ed1f 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -425,13 +425,9 @@ export namespace places_v1 { */ content?: Schema$GoogleTypeLocalizedText; /** - * Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. References that are related to this block of content. - */ - references?: Schema$GoogleMapsPlacesV1References; - /** - * The topic of the content, for example "overview" or "restaurant". + * The list of resource names of the referenced places. This name can be used in other APIs that accept Place resource names. */ - topic?: string | null; + referencedPlaces?: string[] | null; } /** * Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Content that is contextual to the place query. @@ -641,10 +637,6 @@ export namespace places_v1 { * Place allows dogs. */ allowsDogs?: boolean | null; - /** - * Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. - */ - areaSummary?: Schema$GoogleMapsPlacesV1PlaceAreaSummary; /** * A set of data provider that must be shown with this result. */ @@ -685,6 +677,10 @@ export namespace places_v1 { * Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered. */ editorialSummary?: Schema$GoogleTypeLocalizedText; + /** + * The summary of amenities near the EV charging station. + */ + evChargeAmenitySummary?: Schema$GoogleMapsPlacesV1PlaceEvChargeAmenitySummary; /** * Information of ev charging options. */ @@ -698,7 +694,7 @@ export namespace places_v1 { */ fuelOptions?: Schema$GoogleMapsPlacesV1FuelOptions; /** - * Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the place. + * AI-generated summary of the place. */ generativeSummary?: Schema$GoogleMapsPlacesV1PlaceGenerativeSummary; /** @@ -757,6 +753,10 @@ export namespace places_v1 { * A human-readable phone number for the place, in national format. */ nationalPhoneNumber?: string | null; + /** + * A summary of points of interest near the place. + */ + neighborhoodSummary?: Schema$GoogleMapsPlacesV1PlaceNeighborhoodSummary; /** * Place provides outdoor seating. */ @@ -806,7 +806,7 @@ export namespace places_v1 { */ rating?: number | null; /** - * The regular hours of operation. Note that if a place is always open (24 hours), the `close` field will not be set. Clients can rely on always open (24 hours) being represented as an `open` period containing `day` with value `0`, `hour` with value `0`, and `minute` with value `0`. + * The regular hours of operation. Note that if a place is always open (24 hours), the `close` field will not be set. Clients can rely on always open (24 hours) being represented as an [`open`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Period) period containing [`day`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`, [`hour`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`, and [`minute`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) with value `0`. */ regularOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours; /** @@ -825,6 +825,10 @@ export namespace places_v1 { * List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned. */ reviews?: Schema$GoogleMapsPlacesV1Review[]; + /** + * AI-generated summary of the place using user reviews. + */ + reviewSummary?: Schema$GoogleMapsPlacesV1PlaceReviewSummary; /** * Specifies if the place serves beer. */ @@ -870,7 +874,7 @@ export namespace places_v1 { */ shortFormattedAddress?: string | null; /** - * A list of sub destinations related to the place. + * A list of sub-destinations related to the place. */ subDestinations?: Schema$GoogleMapsPlacesV1PlaceSubDestination[]; /** @@ -944,19 +948,6 @@ export namespace places_v1 { */ types?: string[] | null; } - /** - * Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the area that the place is in. - */ - export interface Schema$GoogleMapsPlacesV1PlaceAreaSummary { - /** - * Content blocks that compose the area summary. Each block has a separate topic about the area. - */ - contentBlocks?: Schema$GoogleMapsPlacesV1ContentBlock[]; - /** - * A link where users can flag a problem with the summary. - */ - flagContentUri?: string | null; - } /** * Information about data providers of this place. */ @@ -984,17 +975,42 @@ export namespace places_v1 { name?: string | null; } /** - * Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. AI-generated summary of the place. + * The summary of amenities near the EV charging station. This only applies to places with type `electric_vehicle_charging_station`. The `overview` field is guaranteed to be provided while the other fields are optional. */ - export interface Schema$GoogleMapsPlacesV1PlaceGenerativeSummary { + export interface Schema$GoogleMapsPlacesV1PlaceEvChargeAmenitySummary { /** - * The detailed description of the place. + * A summary of the nearby coffee options. */ - description?: Schema$GoogleTypeLocalizedText; + coffee?: Schema$GoogleMapsPlacesV1ContentBlock; /** - * A link where users can flag a problem with the description summary. + * The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available. */ - descriptionFlagContentUri?: string | null; + disclosureText?: Schema$GoogleTypeLocalizedText; + /** + * A link where users can flag a problem with the summary. + */ + flagContentUri?: string | null; + /** + * An overview of the available amenities. This is guaranteed to be provided. + */ + overview?: Schema$GoogleMapsPlacesV1ContentBlock; + /** + * A summary of the nearby restaurants. + */ + restaurant?: Schema$GoogleMapsPlacesV1ContentBlock; + /** + * A summary of the nearby gas stations. + */ + store?: Schema$GoogleMapsPlacesV1ContentBlock; + } + /** + * AI-generated summary of the place. + */ + export interface Schema$GoogleMapsPlacesV1PlaceGenerativeSummary { + /** + * The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available. + */ + disclosureText?: Schema$GoogleTypeLocalizedText; /** * The overview of the place. */ @@ -1003,10 +1019,6 @@ export namespace places_v1 { * A link where users can flag a problem with the overview summary. */ overviewFlagContentUri?: string | null; - /** - * References that are used to generate the summary description. - */ - references?: Schema$GoogleMapsPlacesV1References; } /** * Links to trigger different Google Maps actions. @@ -1033,6 +1045,27 @@ export namespace places_v1 { */ writeAReviewUri?: string | null; } + /** + * A summary of points of interest near the place. + */ + export interface Schema$GoogleMapsPlacesV1PlaceNeighborhoodSummary { + /** + * A detailed description of the neighborhood. + */ + description?: Schema$GoogleMapsPlacesV1ContentBlock; + /** + * The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available. + */ + disclosureText?: Schema$GoogleTypeLocalizedText; + /** + * A link where users can flag a problem with the summary. + */ + flagContentUri?: string | null; + /** + * An overview summary of the neighborhood. + */ + overview?: Schema$GoogleMapsPlacesV1ContentBlock; + } /** * Information about business hour of the place. */ @@ -1181,15 +1214,32 @@ export namespace places_v1 { globalCode?: string | null; } /** - * 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. + * AI-generated summary of the place using user reviews. + */ + export interface Schema$GoogleMapsPlacesV1PlaceReviewSummary { + /** + * The AI disclosure message "Summarized with Gemini" (and its localized variants). This will be in the language specified in the request if available. + */ + disclosureText?: Schema$GoogleTypeLocalizedText; + /** + * A link where users can flag a problem with the summary. + */ + flagContentUri?: string | null; + /** + * The summary of user reviews. + */ + text?: Schema$GoogleTypeLocalizedText; + } + /** + * Sub-destinations are specific places associated with a main place. These provide more specific destinations for users who are searching within 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 { /** - * The place id of the sub destination. + * The place id of the sub-destination. */ id?: string | null; /** - * The resource name of the sub destination. + * The resource name of the sub-destination. */ name?: string | null; } @@ -1215,19 +1265,6 @@ export namespace places_v1 { */ startPrice?: Schema$GoogleTypeMoney; } - /** - * Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Reference that the generative content is related to. - */ - export interface Schema$GoogleMapsPlacesV1References { - /** - * The list of resource names of the referenced places. This name can be used in other APIs that accept Place resource names. - */ - places?: string[] | null; - /** - * Reviews that serve as references. - */ - reviews?: Schema$GoogleMapsPlacesV1Review[]; - } /** * Information about a review of a place. */ @@ -1268,6 +1305,23 @@ export namespace places_v1 { * The localized text of the review. */ text?: Schema$GoogleTypeLocalizedText; + /** + * The date when the author visited the place. This is trucated to month. + */ + visitDate?: Schema$GoogleMapsPlacesV1ReviewVisitDate; + } + /** + * The date when the author visited the place. This is trucated to month. + */ + export interface Schema$GoogleMapsPlacesV1ReviewVisitDate { + /** + * The month the author visited the place, e.g. 4. The value is between 1 and 12. + */ + month?: number | null; + /** + * The year the author visited the place, e.g. 2025. + */ + year?: number | null; } /** * Encapsulates a set of optional conditions to satisfy when calculating the routes. @@ -1611,15 +1665,15 @@ 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 + * 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 or 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). + * 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 or 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). In 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. + * 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. 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; /** @@ -1627,7 +1681,7 @@ export namespace places_v1 { */ 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. + * Optional. Generally refers to the city or 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; /** @@ -1635,7 +1689,7 @@ export namespace places_v1 { */ 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.). + * 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 or zip code validation in the United States). */ postalCode?: string | null; /** @@ -1651,11 +1705,11 @@ export namespace places_v1 { */ 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). + * 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" (Côte d'Ivoire). */ sortingCode?: string | null; /** - * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. */ sublocality?: string | null; } diff --git a/src/apis/policysimulator/v1.ts b/src/apis/policysimulator/v1.ts index 5cd5ca4f4c0..19654cf312a 100644 --- a/src/apis/policysimulator/v1.ts +++ b/src/apis/policysimulator/v1.ts @@ -130,148 +130,6 @@ export namespace policysimulator_v1 { } } - /** - * Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run. - */ - export interface Schema$GoogleCloudOrgpolicyV2AlternatePolicySpec { - /** - * Reference to the launch that will be used while audit logging and to control the launch. Should be set only in the alternate policy. - */ - launch?: string | null; - /** - * Specify constraint for configurations of Google Cloud resources. - */ - spec?: Schema$GoogleCloudOrgpolicyV2PolicySpec; - } - /** - * A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. - */ - export interface Schema$GoogleCloudOrgpolicyV2CustomConstraint { - /** - * Allow or deny type. - */ - actionType?: string | null; - /** - * A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. - */ - condition?: string | null; - /** - * Detailed information about this custom policy constraint. The max length of the description is 2000 characters. - */ - description?: string | null; - /** - * One line display name for the UI. The max length of the display_name is 200 characters. - */ - displayName?: string | null; - /** - * All the operations being applied for this constraint. - */ - methodTypes?: string[] | null; - /** - * Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id\}/customConstraints/{custom_constraint_id\}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id\}/customConstraints/` is not counted. - */ - name?: string | null; - /** - * Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. - */ - resourceTypes?: string[] | null; - /** - * Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` methods were called. - */ - updateTime?: string | null; - } - /** - * Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources. - */ - export interface Schema$GoogleCloudOrgpolicyV2Policy { - /** - * Deprecated. - */ - alternate?: Schema$GoogleCloudOrgpolicyV2AlternatePolicySpec; - /** - * Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced. - */ - dryRunSpec?: Schema$GoogleCloudOrgpolicyV2PolicySpec; - /** - * Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This 'etag' 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; - /** - * Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number\}/policies/{constraint_name\}` * `folders/{folder_id\}/policies/{constraint_name\}` * `organizations/{organization_id\}/policies/{constraint_name\}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id\}/policies/{constraint_name\}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. - */ - name?: string | null; - /** - * Basic information about the organization policy. - */ - spec?: Schema$GoogleCloudOrgpolicyV2PolicySpec; - } - /** - * Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. - */ - export interface Schema$GoogleCloudOrgpolicyV2PolicySpec { - /** - * An opaque tag indicating the current version of the policySpec, used for concurrency control. This field is ignored if used in a `CreatePolicy` request. When the policy is returned from either a `GetPolicy` or a `ListPolicies` request, this `etag` indicates the version of the current policySpec to use when executing a read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset. - */ - etag?: string | null; - /** - * Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints. - */ - inheritFromParent?: boolean | null; - /** - * Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false. - */ - reset?: boolean | null; - /** - * In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence. - */ - rules?: Schema$GoogleCloudOrgpolicyV2PolicySpecPolicyRule[]; - /** - * Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. - */ - updateTime?: string | null; - } - /** - * A rule used to express this policy. - */ - export interface Schema$GoogleCloudOrgpolicyV2PolicySpecPolicyRule { - /** - * Setting this to true means that all values are allowed. This field can be set only in policies for list constraints. - */ - allowAll?: boolean | null; - /** - * A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the "||" or "&&" operators. Each subexpression must be of the form "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - */ - condition?: Schema$GoogleTypeExpr; - /** - * Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - */ - denyAll?: boolean | null; - /** - * If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. - */ - enforce?: boolean | null; - /** - * 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; - /** - * List of values to be used for this policy rule. This field can be set only in policies for list constraints. - */ - values?: Schema$GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues; - } - /** - * A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - `projects/` (for example, `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. - */ - export interface Schema$GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues { - /** - * List of values allowed at this resource. - */ - allowedValues?: string[] | null; - /** - * List of values denied at this resource. - */ - deniedValues?: string[] | null; - } /** * A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple. */ @@ -306,316 +164,6 @@ export namespace policysimulator_v1 { */ principal?: string | null; } - /** - * CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation. - */ - export interface Schema$GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata { - /** - * Time when the request was received. - */ - requestTime?: string | null; - /** - * Total number of resources that need scanning. Should equal resource_scanned + resources_pending - */ - resourcesFound?: number | null; - /** - * Number of resources still to scan. - */ - resourcesPending?: number | null; - /** - * Number of resources already scanned. - */ - resourcesScanned?: number | null; - /** - * Time when the request started processing, i.e., when the state was set to RUNNING. - */ - startTime?: string | null; - /** - * Output only. The current state of the operation. - */ - state?: string | null; - } - /** - * GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation. - */ - export interface Schema$GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata { - /** - * Time when the request was received. - */ - requestTime?: string | null; - /** - * Total number of resources that need scanning. Should equal resource_scanned + resources_pending - */ - resourcesFound?: number | null; - /** - * Number of resources still to scan. - */ - resourcesPending?: number | null; - /** - * Number of resources already scanned. - */ - resourcesScanned?: number | null; - /** - * Time when the request started processing, i.e. when the state was set to RUNNING. - */ - startTime?: string | null; - /** - * The current state of the operation. - */ - state?: string | null; - } - /** - * The proposed changes to OrgPolicy. - */ - export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay { - /** - * Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint. - */ - customConstraints?: Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay[]; - /** - * Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated. - */ - policies?: Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay[]; - } - /** - * A change to an OrgPolicy custom constraint. - */ - export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay { - /** - * Optional. The new or updated custom constraint. - */ - customConstraint?: Schema$GoogleCloudOrgpolicyV2CustomConstraint; - /** - * Optional. Resource the constraint is attached to. Example: "organization/987654" - */ - customConstraintParent?: string | null; - } - /** - * A change to an OrgPolicy. - */ - export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay { - /** - * Optional. The new or updated OrgPolicy. - */ - policy?: Schema$GoogleCloudOrgpolicyV2Policy; - /** - * Optional. The parent of the policy we are attaching to. Example: "projects/123456" - */ - policyParent?: string | null; - } - /** - * OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field. - */ - export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview { - /** - * Output only. Time when this `OrgPolicyViolationsPreview` was created. - */ - createTime?: string | null; - /** - * Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id\}/customConstraints/{custom_constraint_id\}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - */ - customConstraints?: string[] | null; - /** - * Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization\}/locations/{location\}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview\}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - */ - name?: string | null; - /** - * Required. The proposed changes we are previewing violations for. - */ - overlay?: Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay; - /** - * Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy. - */ - resourceCounts?: Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts; - /** - * Output only. The state of the `OrgPolicyViolationsPreview`. - */ - state?: string | null; - /** - * Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints. - */ - violationsCount?: number | null; - } - /** - * A summary of the state of all resources scanned for compliance with the changed OrgPolicy. - */ - export interface Schema$GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts { - /** - * Output only. Number of scanned resources with zero violations. - */ - compliant?: number | null; - /** - * Output only. Number of resources that returned an error when scanned. - */ - errors?: number | null; - /** - * Output only. Number of scanned resources with at least one violation. - */ - noncompliant?: number | null; - /** - * Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error - */ - scanned?: number | null; - /** - * Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource. - */ - unenforced?: number | null; - } - /** - * CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation. - */ - export interface Schema$GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata { - /** - * Time when the request was received. - */ - requestTime?: string | null; - /** - * Total number of resources that need scanning. Should equal resource_scanned + resources_pending - */ - resourcesFound?: number | null; - /** - * Number of resources still to scan. - */ - resourcesPending?: number | null; - /** - * Number of resources already scanned. - */ - resourcesScanned?: number | null; - /** - * Time when the request started processing, i.e., when the state was set to RUNNING. - */ - startTime?: string | null; - /** - * Output only. The current state of the operation. - */ - state?: string | null; - } - /** - * GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation. - */ - export interface Schema$GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata { - /** - * Time when the request was received. - */ - requestTime?: string | null; - /** - * Total number of resources that need scanning. Should equal resource_scanned + resources_pending - */ - resourcesFound?: number | null; - /** - * Number of resources still to scan. - */ - resourcesPending?: number | null; - /** - * Number of resources already scanned. - */ - resourcesScanned?: number | null; - /** - * Time when the request started processing, i.e. when the state was set to RUNNING. - */ - startTime?: string | null; - /** - * The current state of the operation. - */ - state?: string | null; - } - /** - * The proposed changes to OrgPolicy. - */ - export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay { - /** - * Optional. The OrgPolicy CustomConstraint changes to preview violations for. Any existing CustomConstraints with the same name will be overridden in the simulation. That is, violations will be determined as if all custom constraints in the overlay were instantiated. Only a single custom_constraint is supported in the overlay at a time. For evaluating multiple constraints, multiple `GenerateOrgPolicyViolationsPreview` requests are made, where each request evaluates a single constraint. - */ - customConstraints?: Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay[]; - /** - * Optional. The OrgPolicy changes to preview violations for. Any existing OrgPolicies with the same name will be overridden in the simulation. That is, violations will be determined as if all policies in the overlay were created or updated. - */ - policies?: Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay[]; - } - /** - * A change to an OrgPolicy custom constraint. - */ - export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay { - /** - * Optional. The new or updated custom constraint. - */ - customConstraint?: Schema$GoogleCloudOrgpolicyV2CustomConstraint; - /** - * Optional. Resource the constraint is attached to. Example: "organization/987654" - */ - customConstraintParent?: string | null; - } - /** - * A change to an OrgPolicy. - */ - export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay { - /** - * Optional. The new or updated OrgPolicy. - */ - policy?: Schema$GoogleCloudOrgpolicyV2Policy; - /** - * Optional. The parent of the policy we are attaching to. Example: "projects/123456" - */ - policyParent?: string | null; - } - /** - * OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field. - */ - export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview { - /** - * Output only. Time when this `OrgPolicyViolationsPreview` was created. - */ - createTime?: string | null; - /** - * Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id\}/customConstraints/{custom_constraint_id\}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - */ - customConstraints?: string[] | null; - /** - * Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization\}/locations/{location\}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview\}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - */ - name?: string | null; - /** - * Required. The proposed changes we are previewing violations for. - */ - overlay?: Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay; - /** - * Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy. - */ - resourceCounts?: Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts; - /** - * Output only. The state of the `OrgPolicyViolationsPreview`. - */ - state?: string | null; - /** - * Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each OrgPolicyViolation is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints. - */ - violationsCount?: number | null; - } - /** - * A summary of the state of all resources scanned for compliance with the changed OrgPolicy. - */ - export interface Schema$GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts { - /** - * Output only. Number of scanned resources with zero violations. - */ - compliant?: number | null; - /** - * Output only. Number of resources that returned an error when scanned. - */ - errors?: number | null; - /** - * Output only. Number of scanned resources with at least one violation. - */ - noncompliant?: number | null; - /** - * Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error - */ - scanned?: number | null; - /** - * Output only. Number of resources where the constraint was not enforced, i.e. the Policy set `enforced: false` for that resource. - */ - unenforced?: number | null; - } /** * Details about how a binding in a policy affects a principal's ability to use a permission. */ diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index 22352614628..04d10ec5f5b 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -1657,6 +1657,10 @@ export namespace privateca_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/privateca/v1beta1.ts b/src/apis/privateca/v1beta1.ts index 2e32b9c73c9..417dba64416 100644 --- a/src/apis/privateca/v1beta1.ts +++ b/src/apis/privateca/v1beta1.ts @@ -569,6 +569,10 @@ export namespace privateca_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index a0dc7ec76f5..ebe7c7510a6 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -518,7 +518,7 @@ export namespace pubsub_v1 { */ 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) { \} ``` + * 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: * - (optional) 'message_id' : {string\} * - (optional) 'publish_time': {string\} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string\} x/ function (message, metadata) { \} ``` */ code?: string | null; /** @@ -635,7 +635,11 @@ export namespace pubsub_v1 { */ 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`. + * Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`. + */ + disabled?: boolean | null; + /** + * Optional. This field is deprecated, use the `disabled` field to disable transforms. */ enabled?: boolean | null; /** diff --git a/src/apis/rapidmigrationassessment/v1.ts b/src/apis/rapidmigrationassessment/v1.ts index a53311b3cc3..1d500d79482 100644 --- a/src/apis/rapidmigrationassessment/v1.ts +++ b/src/apis/rapidmigrationassessment/v1.ts @@ -628,6 +628,10 @@ export namespace rapidmigrationassessment_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/recommender/v1beta1.ts b/src/apis/recommender/v1beta1.ts index 525a035c4e4..15aa8fa65a0 100644 --- a/src/apis/recommender/v1beta1.ts +++ b/src/apis/recommender/v1beta1.ts @@ -849,6 +849,10 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Billingaccounts$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -2454,6 +2458,10 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Folders$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -3738,6 +3746,10 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Organizations$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -5343,6 +5355,10 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 0690d02c70f..912489012c5 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -2142,6 +2142,10 @@ export namespace redis_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -2357,7 +2361,7 @@ export namespace redis_v1 { export interface Params$Resource$Projects$Locations$Backupcollections$Get extends StandardParameters { /** - * Required. Redis backupCollection resource name using the form: `projects/{project_id\}/locations/{location_id\}/backupCollections/{backup_collection_id\}` where `location_id` refers to a GCP region. + * Required. Redis backupCollection resource name using the form: `projects/{project_id\}/locations/{location_id\}/backupCollections/{backup_collection_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; } @@ -2372,7 +2376,7 @@ export namespace redis_v1 { */ pageToken?: string; /** - * Required. The resource name of the backupCollection location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + * Required. The resource name of the backupCollection location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a Google Cloud region. */ parent?: string; } @@ -3495,7 +3499,7 @@ export namespace redis_v1 { export interface Params$Resource$Projects$Locations$Clusters$Backup extends StandardParameters { /** - * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; @@ -3511,7 +3515,7 @@ export namespace redis_v1 { */ clusterId?: string; /** - * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a Google Cloud region. */ parent?: string; /** @@ -3527,7 +3531,7 @@ export namespace redis_v1 { export interface Params$Resource$Projects$Locations$Clusters$Delete extends StandardParameters { /** - * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; /** @@ -3538,14 +3542,14 @@ export namespace redis_v1 { export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters { /** - * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; } export interface Params$Resource$Projects$Locations$Clusters$Getcertificateauthority extends StandardParameters { /** - * Required. Redis cluster certificate authority resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}/certificateAuthority` where `location_id` refers to a GCP region. + * Required. Redis cluster certificate authority resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}/certificateAuthority` where `location_id` refers to a Google Cloud region. */ name?: string; } @@ -3560,7 +3564,7 @@ export namespace redis_v1 { */ pageToken?: string; /** - * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a Google Cloud region. */ parent?: string; } @@ -3587,7 +3591,7 @@ export namespace redis_v1 { export interface Params$Resource$Projects$Locations$Clusters$Rescheduleclustermaintenance extends StandardParameters { /** - * Required. Redis Cluster instance resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis Cluster instance resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 91b3e8af11e..0decc34bd1b 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -2142,6 +2142,10 @@ export namespace redis_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -2357,7 +2361,7 @@ export namespace redis_v1beta1 { export interface Params$Resource$Projects$Locations$Backupcollections$Get extends StandardParameters { /** - * Required. Redis backupCollection resource name using the form: `projects/{project_id\}/locations/{location_id\}/backupCollections/{backup_collection_id\}` where `location_id` refers to a GCP region. + * Required. Redis backupCollection resource name using the form: `projects/{project_id\}/locations/{location_id\}/backupCollections/{backup_collection_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; } @@ -2372,7 +2376,7 @@ export namespace redis_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the backupCollection location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + * Required. The resource name of the backupCollection location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a Google Cloud region. */ parent?: string; } @@ -3500,7 +3504,7 @@ export namespace redis_v1beta1 { export interface Params$Resource$Projects$Locations$Clusters$Backup extends StandardParameters { /** - * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; @@ -3516,7 +3520,7 @@ export namespace redis_v1beta1 { */ clusterId?: string; /** - * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a Google Cloud region. */ parent?: string; /** @@ -3532,7 +3536,7 @@ export namespace redis_v1beta1 { export interface Params$Resource$Projects$Locations$Clusters$Delete extends StandardParameters { /** - * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; /** @@ -3543,14 +3547,14 @@ export namespace redis_v1beta1 { export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters { /** - * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; } export interface Params$Resource$Projects$Locations$Clusters$Getcertificateauthority extends StandardParameters { /** - * Required. Redis cluster certificate authority resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}/certificateAuthority` where `location_id` refers to a GCP region. + * Required. Redis cluster certificate authority resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}/certificateAuthority` where `location_id` refers to a Google Cloud region. */ name?: string; } @@ -3565,7 +3569,7 @@ export namespace redis_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a Google Cloud region. */ parent?: string; } @@ -3592,7 +3596,7 @@ export namespace redis_v1beta1 { export interface Params$Resource$Projects$Locations$Clusters$Rescheduleclustermaintenance extends StandardParameters { /** - * Required. Redis Cluster instance resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + * Required. Redis Cluster instance resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a Google Cloud region. */ name?: string; diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index 7d81d223888..ee4c30a4798 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -296,7 +296,7 @@ export namespace reseller_v1 { */ kind?: string | null; /** - * Read-only field containing the current number of users that are assigned a license for the product defined in `skuId`. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: [`listForProductAndSku`](/admin-sdk/licensing/v1/reference/licenseAssignments/listForProductAndSku). + * Read-only field containing the current number of users that are assigned a license for the product defined in `skuId`. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: [`listForProductAndSku`](https://developers.google.com/workspace/admin/licensing/v1/reference/licenseAssignments/listForProductAndSku). */ licensedNumberOfSeats?: number | null; /** @@ -418,7 +418,7 @@ export namespace reseller_v1 { } /** - * Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#get_customer). + * Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#get_customer). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -505,7 +505,7 @@ export namespace reseller_v1 { } /** - * Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](/admin-sdk/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\` as described in [order a resold account for an existing customer](/admin-sdk/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#tos). + * Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](https://developers.google.com/workspace/admin/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\` as described in [order a resold account for an existing customer](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#tos). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -679,7 +679,7 @@ export namespace reseller_v1 { } /** - * Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `"team"` customer can verify their domain and become `customerType = "domain"`. For more information, see [update a customer's settings](/admin-sdk/reseller/v1/how-tos/manage_customers#update_customer). + * Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `"team"` customer can verify their domain and become `customerType = "domain"`. For more information, see [update a customer's settings](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#update_customer). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1209,7 +1209,7 @@ export namespace reseller_v1 { } /** - * Updates a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan). + * Updates a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1297,7 +1297,7 @@ export namespace reseller_v1 { } /** - * Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_renewal). + * Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_renewal). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1387,7 +1387,7 @@ export namespace reseller_v1 { } /** - * Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see [Manage Subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat). + * Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see [Manage Subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1561,7 +1561,7 @@ export namespace reseller_v1 { } /** - * Gets a specific subscription. The `subscriptionId` can be found using the [Retrieve all reseller subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. For more information about retrieving a specific subscription, see the information descrived in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_subscription). + * Gets a specific subscription. The `subscriptionId` can be found using the [Retrieve all reseller subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. For more information about retrieving a specific subscription, see the information descrived in [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_subscription). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1649,7 +1649,7 @@ export namespace reseller_v1 { } /** - * Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the [Order a new customer account](/admin-sdk/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#create_subscription).\ If you did not order the customer's account using the customer insert method, use the customer's `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the [batch operation](/admin-sdk/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to [transfer subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription). + * Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the [Order a new customer account](https://developers.google.com/workspace/admin/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#create_subscription).\ If you did not order the customer's account using the customer insert method, use the customer's `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the [batch operation](https://developers.google.com/workspace/admin/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to [transfer subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1736,7 +1736,7 @@ export namespace reseller_v1 { } /** - * Lists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions). + * Lists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1824,7 +1824,7 @@ export namespace reseller_v1 { } /** - * Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#paid_service). + * Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#paid_service). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index e378b1b7ba9..d4af074ca73 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -1561,7 +1561,7 @@ export namespace retail_v2 { */ export interface Schema$GoogleCloudRetailV2CompleteQueryResponse { /** - * A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: * `brands` * `categories` + * A map of matched attribute suggestions. This field is only available for `cloud-retail` dataset. Current supported keys: * `brands` * `categories` */ attributeResults?: { [ @@ -1595,7 +1595,7 @@ export namespace retail_v2 { */ export interface Schema$GoogleCloudRetailV2CompleteQueryResponseCompletionResult { /** - * Custom attributes for the suggestion term. * For "user-data", the attributes are additional custom attributes ingested through BigQuery. * For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. + * Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. */ attributes?: { [key: string]: Schema$GoogleCloudRetailV2CustomAttribute; @@ -2226,7 +2226,7 @@ export namespace retail_v2 { [key: string]: Schema$GoogleCloudRetailV2CustomAttribute; } | null; /** - * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). + * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details. */ availability?: string | null; /** @@ -2234,7 +2234,7 @@ export namespace retail_v2 { */ fulfillmentTypes?: string[] | null; /** - * Required. The place ID for the current set of inventory information. + * Optional. The place ID for the current set of inventory information. */ placeId?: string | null; /** @@ -3292,7 +3292,7 @@ export namespace retail_v2 { */ export interface Schema$GoogleCloudRetailV2SearchRequestBoostSpec { /** - * Condition boost specifications. If a product 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. + * Condition boost specifications. If a product 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$GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec[]; /** @@ -5408,7 +5408,7 @@ export namespace retail_v2 { */ catalog?: string; /** - * Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset). + * Determines which dataset to use for fetching completion. "user-data" will use the dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset). */ dataset?: string; /** @@ -5416,11 +5416,11 @@ export namespace retail_v2 { */ deviceType?: string; /** - * If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset. + * If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset. */ 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. 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. + * 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. This field will be applied to `completion_results` only. It has no effect on the `attribute_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; /** diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 203fb30503a..294ab540347 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -745,7 +745,7 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaCompleteQueryResponse { /** - * A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: * `brands` * `categories` + * A map of matched attribute suggestions. This field is only available for `cloud-retail` dataset. Current supported keys: * `brands` * `categories` */ attributeResults?: { [ @@ -779,7 +779,7 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult { /** - * Custom attributes for the suggestion term. * For "user-data", the attributes are additional custom attributes ingested through BigQuery. * For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. + * Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. */ attributes?: { [key: string]: Schema$GoogleCloudRetailV2alphaCustomAttribute; @@ -1727,7 +1727,7 @@ export namespace retail_v2alpha { [key: string]: Schema$GoogleCloudRetailV2alphaCustomAttribute; } | null; /** - * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). + * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details. */ availability?: string | null; /** @@ -1735,7 +1735,7 @@ export namespace retail_v2alpha { */ fulfillmentTypes?: string[] | null; /** - * Required. The place ID for the current set of inventory information. + * Optional. The place ID for the current set of inventory information. */ placeId?: string | null; /** @@ -3013,7 +3013,7 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaSearchRequestBoostSpec { /** - * Condition boost specifications. If a product 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. + * Condition boost specifications. If a product 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$GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec[]; /** @@ -6657,7 +6657,7 @@ export namespace retail_v2alpha { */ catalog?: string; /** - * Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset). + * Determines which dataset to use for fetching completion. "user-data" will use the dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset). */ dataset?: string; /** @@ -6665,11 +6665,11 @@ export namespace retail_v2alpha { */ deviceType?: string; /** - * If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset. + * If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset. */ 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. 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. + * 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. This field will be applied to `completion_results` only. It has no effect on the `attribute_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; /** diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 05d20a2c56f..1d9c262f8c8 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -1234,7 +1234,7 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2betaCompleteQueryResponse { /** - * A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: * `brands` * `categories` + * A map of matched attribute suggestions. This field is only available for `cloud-retail` dataset. Current supported keys: * `brands` * `categories` */ attributeResults?: { [ @@ -1268,7 +1268,7 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult { /** - * Custom attributes for the suggestion term. * For "user-data", the attributes are additional custom attributes ingested through BigQuery. * For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. + * Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. */ attributes?: { [key: string]: Schema$GoogleCloudRetailV2betaCustomAttribute; @@ -1963,7 +1963,7 @@ export namespace retail_v2beta { [key: string]: Schema$GoogleCloudRetailV2betaCustomAttribute; } | null; /** - * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). + * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details. */ availability?: string | null; /** @@ -1971,7 +1971,7 @@ export namespace retail_v2beta { */ fulfillmentTypes?: string[] | null; /** - * Required. The place ID for the current set of inventory information. + * Optional. The place ID for the current set of inventory information. */ placeId?: string | null; /** @@ -3084,7 +3084,7 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2betaSearchRequestBoostSpec { /** - * Condition boost specifications. If a product 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. + * Condition boost specifications. If a product 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$GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec[]; /** @@ -5773,7 +5773,7 @@ export namespace retail_v2beta { */ catalog?: string; /** - * Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset). + * Determines which dataset to use for fetching completion. "user-data" will use the dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset). */ dataset?: string; /** @@ -5781,11 +5781,11 @@ export namespace retail_v2beta { */ deviceType?: string; /** - * If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset. + * If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset. */ 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. 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. + * 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. This field will be applied to `completion_results` only. It has no effect on the `attribute_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; /** diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 147eaa847a0..4649eaccbad 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -1361,7 +1361,7 @@ export namespace run_v1 { */ groupId?: string | null; /** - * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + * Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. */ path?: string | null; /** @@ -1849,6 +1849,23 @@ export namespace run_v1 { */ value?: 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$InstanceSplit { + /** + * Uses the "status.latestReadyRevisionName" to determine the traffic target. When it changes, traffic will automatically migrate from the prior "latest ready" revision to the new one. + */ + latestRevision?: boolean | null; + /** + * 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. + */ + revisionName?: string | null; + } /** * Job represents the configuration of a single job, which references a container image which is run to completion. */ @@ -2172,6 +2189,31 @@ export namespace run_v1 { */ unreachable?: string[] | null; } + /** + * A list of WorkerPool resources. + */ + export interface Schema$ListWorkerPoolsResponse { + /** + * The API version for this call; returns "run.googleapis.com/v1". + */ + apiVersion?: string | null; + /** + * List of WorkerPools. + */ + items?: Schema$WorkerPool[]; + /** + * The kind of this resource; returns "WorkerPoolList". + */ + kind?: string | null; + /** + * Metadata associated with this WorkerPool list. + */ + metadata?: Schema$ListMeta; + /** + * For calls against the global endpoint, returns the list of Cloud locations that could not be reached. For regional calls, this field is not used. + */ + unreachable?: string[] | null; + } /** * Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ @@ -2228,7 +2270,7 @@ export namespace run_v1 { */ export interface Schema$ObjectMeta { /** - * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. */ annotations?: {[key: string]: string} | null; /** @@ -2484,7 +2526,7 @@ export namespace run_v1 { */ serviceAccountName?: string | null; /** - * TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour). + * Optional. TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour). */ timeoutSeconds?: number | null; volumes?: Schema$Volume[]; @@ -3046,6 +3088,69 @@ export namespace run_v1 { */ subPath?: string | null; } + /** + * WorkerPool acts as a top-level container that manages a set instance splits among a set of Revisions and a template for creating new Revisions. + */ + export interface Schema$WorkerPool { + /** + * The API version for this call. It must be "run.googleapis.com/v1". + */ + apiVersion?: string | null; + /** + * The kind of resource. It must be "WorkerPool". + */ + kind?: string | null; + /** + * Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` + */ + metadata?: Schema$ObjectMeta; + /** + * Holds the desired state of the WorkerPool (from the client). + */ + spec?: Schema$WorkerPoolSpec; + /** + * Communicates the system-controlled state of the WorkerPool. + */ + status?: Schema$WorkerPoolStatus; + } + /** + * WorkerPoolSpec holds the desired state of the WorkerPool's template and instance splits. + */ + export interface Schema$WorkerPoolSpec { + /** + * Specifies how to distribute instances over a collection of Revisions. + */ + instanceSplits?: Schema$InstanceSplit[]; + /** + * Holds the latest specification for the Revision to be stamped out. + */ + template?: Schema$RevisionTemplate; + } + /** + * The current state of the WorkerPool. Output only. + */ + export interface Schema$WorkerPoolStatus { + /** + * Conditions communicate information about ongoing/complete reconciliation processes that bring the `spec` inline with the observed state of the world. * `Ready`: `True` when all underlying resources are ready. + */ + conditions?: Schema$GoogleCloudRunV1Condition[]; + /** + * Holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. + */ + instanceSplits?: Schema$InstanceSplit[]; + /** + * Name of the last revision that was created from this WorkerPool's template. It might not be ready yet, for that use LatestReadyRevisionName. + */ + latestCreatedRevisionName?: string | null; + /** + * Name of the latest Revision from this WorkerPool's template that has had its `Ready` condition become `True`. + */ + latestReadyRevisionName?: string | null; + /** + * Returns the generation last seen by the system. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. + */ + observedGeneration?: number | null; + } export class Resource$Namespaces { context: APIRequestContext; @@ -3058,6 +3163,7 @@ export namespace run_v1 { routes: Resource$Namespaces$Routes; services: Resource$Namespaces$Services; tasks: Resource$Namespaces$Tasks; + workerpools: Resource$Namespaces$Workerpools; constructor(context: APIRequestContext) { this.context = context; this.authorizeddomains = new Resource$Namespaces$Authorizeddomains( @@ -3075,6 +3181,7 @@ export namespace run_v1 { this.routes = new Resource$Namespaces$Routes(this.context); this.services = new Resource$Namespaces$Services(this.context); this.tasks = new Resource$Namespaces$Tasks(this.context); + this.workerpools = new Resource$Namespaces$Workerpools(this.context); } } @@ -6288,6 +6395,526 @@ export namespace run_v1 { watch?: boolean; } + export class Resource$Namespaces$Workerpools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new WorkerPool. WorkerPool creation will trigger a new deployment. Use GetWorkerPool, and check worker_pool.status to determine if the WorkerPool is ready. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Namespaces$Workerpools$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Namespaces$Workerpools$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Workerpools$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Workerpools$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Workerpools$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Namespaces$Workerpools$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Workerpools$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/run.googleapis.com/v1/{+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 the provided worker pool. This will cause the WorkerPool to stop all instances and will delete all associated WorkerPoolRevisions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Namespaces$Workerpools$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Namespaces$Workerpools$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Workerpools$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Workerpools$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Workerpools$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Workerpools$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Workerpools$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/run.googleapis.com/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 information about a worker pool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Namespaces$Workerpools$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Namespaces$Workerpools$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Workerpools$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Workerpools$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Workerpools$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Workerpools$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Workerpools$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/run.googleapis.com/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 worker pools for the given project and region. 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$Namespaces$Workerpools$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Namespaces$Workerpools$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Workerpools$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Workerpools$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Workerpools$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Workerpools$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Workerpools$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/run.googleapis.com/v1/{+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); + } + } + + /** + * Replaces a worker pool. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency 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. + */ + replaceWorkerPool( + params: Params$Resource$Namespaces$Workerpools$Replaceworkerpool, + options: StreamMethodOptions + ): GaxiosPromise; + replaceWorkerPool( + params?: Params$Resource$Namespaces$Workerpools$Replaceworkerpool, + options?: MethodOptions + ): GaxiosPromise; + replaceWorkerPool( + params: Params$Resource$Namespaces$Workerpools$Replaceworkerpool, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceWorkerPool( + params: Params$Resource$Namespaces$Workerpools$Replaceworkerpool, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceWorkerPool( + params: Params$Resource$Namespaces$Workerpools$Replaceworkerpool, + callback: BodyResponseCallback + ): void; + replaceWorkerPool(callback: BodyResponseCallback): void; + replaceWorkerPool( + paramsOrCallback?: + | Params$Resource$Namespaces$Workerpools$Replaceworkerpool + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Workerpools$Replaceworkerpool; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Workerpools$Replaceworkerpool; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/apis/run.googleapis.com/v1/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Namespaces$Workerpools$Create + extends StandardParameters { + /** + * Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all` + */ + dryRun?: string; + /** + * Required. The resource's parent. In Cloud Run, it may be one of the following: * `{project_id_or_number\}` * `namespaces/{project_id_or_number\}` * `namespaces/{project_id_or_number\}/workerpools` * `projects/{project_id_or_number\}/locations/{region\}` * `projects/{project_id_or_number\}/regions/{region\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkerPool; + } + export interface Params$Resource$Namespaces$Workerpools$Delete + extends StandardParameters { + /** + * Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all` + */ + dryRun?: string; + /** + * Required. The fully qualified name of the worker pool to delete. It can be any of the following forms: * `namespaces/{project_id_or_number\}/workerpools/{worker_pool_name\}` (only when the `endpoint` is regional) * `projects/{project_id_or_number\}/locations/{region\}/workerpools/{worker_pool_name\}` * `projects/{project_id_or_number\}/regions/{region\}/workerpools/{worker_pool_name\}` + */ + name?: string; + } + export interface Params$Resource$Namespaces$Workerpools$Get + extends StandardParameters { + /** + * Required. The fully qualified name of the worker pool to retrieve. It can be any of the following forms: * `namespaces/{project_id_or_number\}/workerpools/{worker_pool_name\}` (only when the `endpoint` is regional) * `projects/{project_id_or_number\}/locations/{region\}/workerpools/{worker_pool_name\}` * `projects/{project_id_or_number\}/regions/{region\}/workerpools/{worker_pool_name\}` + */ + name?: string; + } + export interface Params$Resource$Namespaces$Workerpools$List + extends StandardParameters { + /** + * Encoded string to continue paging. + */ + continue?: string; + /** + * =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * `{project_id_or_number\}` * `namespaces/{project_id_or_number\}` * `namespaces/{project_id_or_number\}/workerpools` * `projects/{project_id_or_number\}/locations/{region\}` * `projects/{project_id_or_number\}/regions/{region\}` + */ + parent?: string; + } + export interface Params$Resource$Namespaces$Workerpools$Replaceworkerpool + extends StandardParameters { + /** + * Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all` + */ + dryRun?: string; + /** + * Required. The fully qualified name of the worker pool to replace. It can be any of the following forms: * `namespaces/{project_id_or_number\}/workerpools/{worker_pool_name\}` (only when the `endpoint` is regional) * `projects/{project_id_or_number\}/locations/{region\}/workerpools/{worker_pool_name\}` * `projects/{project_id_or_number\}/regions/{region\}/workerpools/{worker_pool_name\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkerPool; + } + export class Resource$Projects { context: APIRequestContext; authorizeddomains: Resource$Projects$Authorizeddomains; @@ -6546,6 +7173,10 @@ export namespace run_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 678926cdf3e..23b2b68c7bd 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -1104,6 +1104,10 @@ export namespace run_v2 { * Output only. A number that monotonically increases every time the user modifies the desired state. */ generation?: string | null; + /** + * Optional. Output only. True if GPU zonal redundancy is disabled on this revision. + */ + gpuZonalRedundancyDisabled?: boolean | null; /** * Output only. 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. */ @@ -1235,6 +1239,10 @@ export namespace run_v2 { * Optional. The sandbox environment to host this Revision. */ executionEnvironment?: string | null; + /** + * Optional. True if GPU zonal redundancy is disabled on this revision. + */ + gpuZonalRedundancyDisabled?: boolean | null; /** * Optional. Disables health checking containers during deployment. */ @@ -1395,12 +1403,16 @@ export namespace run_v2 { * 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. IAP settings on the Service. + */ + iapEnabled?: boolean | null; /** * Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. */ ingress?: string | null; /** - * Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This feature is available by invitation only. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. + * Optional. Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. */ invokerIamDisabled?: boolean | null; /** @@ -1451,6 +1463,10 @@ export namespace run_v2 { * Output only. The Condition of this Service, 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. True if Cloud Run Threat Detection monitoring is enabled for the parent project of this Service. + */ + threatDetectionEnabled?: boolean | null; /** * Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision. */ @@ -1625,6 +1641,10 @@ export namespace run_v2 { * Output only. A number that monotonically increases every time the user modifies the desired state. */ generation?: string | null; + /** + * Optional. Output only. True if GPU zonal redundancy is disabled on this task. + */ + gpuZonalRedundancyDisabled?: boolean | null; /** * Output only. Index of the Task, unique per execution, and beginning at 0. */ @@ -2081,14 +2101,6 @@ export namespace run_v2 { * 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. */ @@ -2710,7 +2722,7 @@ export namespace run_v2 { */ groupId?: string | null; /** - * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + * Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. */ path?: string | null; /** @@ -3268,7 +3280,7 @@ export namespace run_v2 { title?: string | null; } /** - * This is proto2's version of MessageSet. + * This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. */ export interface Schema$Proto2BridgeMessageSet {} /** diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index c6abbd40ab9..069e2301855 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -592,7 +592,7 @@ export namespace script_v1 { */ lastModifyUser?: Schema$GoogleAppsScriptTypeUser; /** - * The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This filed is optional, and if not set, a stand-alone script will be created. + * The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This field is optional, and if not set, a stand-alone script will be created. */ parentId?: string | null; /** diff --git a/src/apis/searchads360/v0.ts b/src/apis/searchads360/v0.ts index 9c079ed6955..dbf86b69ed0 100644 --- a/src/apis/searchads360/v0.ts +++ b/src/apis/searchads360/v0.ts @@ -2768,7 +2768,7 @@ export namespace searchads360_v0 { resourceName?: string | null; } /** - * A view on the usage of ad group ad asset combination. + * A view on the usage of asset group asset top combinations. */ export interface Schema$GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView { /** @@ -3590,6 +3590,10 @@ export namespace searchads360_v0 { * A customer. */ export interface Schema$GoogleAdsSearchads360V0Resources__Customer { + /** + * Output only. The account level of the customer: Manager, Sub-manager, Associate manager, Service account. + */ + accountLevel?: string | null; /** * Output only. Account status, for example, Enabled, Paused, Removed, etc. */ @@ -3598,6 +3602,14 @@ export namespace searchads360_v0 { * Output only. Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc. */ accountType?: string | null; + /** + * Output only. The descriptive name of the associate manager. + */ + associateManagerDescriptiveName?: string | null; + /** + * Output only. The customer ID of the associate manager. A 0 value indicates that the customer has no SA360 associate manager. + */ + associateManagerId?: string | null; /** * Whether auto-tagging is enabled for the customer. */ @@ -3642,6 +3654,14 @@ export namespace searchads360_v0 { * Output only. Whether the customer is a manager. */ manager?: boolean | null; + /** + * Output only. The descriptive name of the manager. + */ + managerDescriptiveName?: string | null; + /** + * Output only. The customer ID of the manager. A 0 value indicates that the customer has no SA360 manager. + */ + managerId?: string | null; /** * Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id\}` */ @@ -3650,6 +3670,14 @@ export namespace searchads360_v0 { * Output only. The status of the customer. */ status?: string | null; + /** + * Output only. The descriptive name of the sub manager. + */ + subManagerDescriptiveName?: string | null; + /** + * Output only. The customer ID of the sub manager. A 0 value indicates that the customer has no sub SA360 manager. + */ + subManagerId?: string | null; /** * Immutable. The local timezone ID of the customer. */ diff --git a/src/apis/secretmanager/v1.ts b/src/apis/secretmanager/v1.ts index 7d8e70397bb..d13f2f5c47c 100644 --- a/src/apis/secretmanager/v1.ts +++ b/src/apis/secretmanager/v1.ts @@ -814,6 +814,10 @@ export namespace secretmanager_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/secretmanager/v1beta1.ts b/src/apis/secretmanager/v1beta1.ts index 5f793b7b1b4..dcbea89665d 100644 --- a/src/apis/secretmanager/v1beta1.ts +++ b/src/apis/secretmanager/v1beta1.ts @@ -644,6 +644,10 @@ export namespace secretmanager_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/secretmanager/v1beta2.ts b/src/apis/secretmanager/v1beta2.ts index 7b7a0c672f5..64a30c50509 100644 --- a/src/apis/secretmanager/v1beta2.ts +++ b/src/apis/secretmanager/v1beta2.ts @@ -814,6 +814,10 @@ export namespace secretmanager_v1beta2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index e6abbacdd90..1dd3b665104 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -219,6 +219,15 @@ export namespace securitycenter_v1 { */ confidence?: number | null; } + /** + * Details about resources affected by this finding. + */ + export interface Schema$AffectedResources { + /** + * The count of resources affected by the finding. + */ + count?: string | null; + } /** * Allowed IP rule. */ @@ -685,6 +694,15 @@ export namespace securitycenter_v1 { */ muteState?: string | null; } + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + */ + export interface Schema$Chokepoint { + /** + * List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + */ + relatedFindings?: string[] | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -786,43 +804,6 @@ export namespace securitycenter_v1 { */ version?: string | null; } - /** - * Result containing the properties and count of a ComplianceSnapshot request. - */ - export interface Schema$ComplianceSnapshot { - /** - * The category of Findings matching. - */ - category?: string | null; - /** - * The cloud provider for the compliance snapshot. - */ - cloudProvider?: string | null; - /** - * The compliance standard (ie CIS). - */ - complianceStandard?: string | null; - /** - * The compliance version (ie 1.3) in CIS 1.3. - */ - complianceVersion?: string | null; - /** - * Total count of findings for the given properties. - */ - count?: string | null; - /** - * The leaf container resource name that is closest to the snapshot. - */ - leafContainerResource?: string | null; - /** - * The compliance snapshot name. Format: //sources//complianceSnapshots/ - */ - name?: string | null; - /** - * The snapshot time of the snapshot. - */ - snapshotTime?: string | null; - } /** * Contains information about the IP connection associated with the finding. */ @@ -1370,6 +1351,10 @@ export namespace securitycenter_v1 { * Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. */ access?: Schema$Access; + /** + * AffectedResources associated with the finding. + */ + affectedResources?: Schema$AffectedResources; /** * Represents an application associated with the finding. */ @@ -1390,6 +1375,10 @@ export namespace securitycenter_v1 { * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ category?: string | null; + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. + */ + chokepoint?: Schema$Chokepoint; /** * Fields related to Cloud Armor findings. */ @@ -2347,6 +2336,15 @@ export namespace securitycenter_v1 { */ confidence?: number | null; } + /** + * Details about resources affected by this finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2AffectedResources { + /** + * The count of resources affected by the finding. + */ + count?: string | null; + } /** * Allowed IP rule. */ @@ -2659,6 +2657,15 @@ export namespace securitycenter_v1 { * The response to a BulkMute request. Contains the LRO information. */ export interface Schema$GoogleCloudSecuritycenterV2BulkMuteFindingsResponse {} + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + */ + export interface Schema$GoogleCloudSecuritycenterV2Chokepoint { + /** + * List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + */ + relatedFindings?: string[] | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -3213,6 +3220,10 @@ export namespace securitycenter_v1 { * Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. */ access?: Schema$GoogleCloudSecuritycenterV2Access; + /** + * AffectedResources associated with the finding. + */ + affectedResources?: Schema$GoogleCloudSecuritycenterV2AffectedResources; /** * Represents an application associated with the finding. */ @@ -3233,6 +3244,10 @@ export namespace securitycenter_v1 { * Immutable. The additional taxonomy group within findings from a given source. Example: "XSS_FLASH_INJECTION" */ category?: string | null; + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. + */ + chokepoint?: Schema$GoogleCloudSecuritycenterV2Chokepoint; /** * Fields related to Cloud Armor findings. */ diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 757eac361e3..e455b8917ba 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -215,6 +215,15 @@ export namespace securitycenter_v1beta1 { */ confidence?: number | null; } + /** + * Details about resources affected by this finding. + */ + export interface Schema$AffectedResources { + /** + * The count of resources affected by the finding. + */ + count?: string | null; + } /** * Allowed IP rule. */ @@ -554,6 +563,15 @@ export namespace securitycenter_v1beta1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + */ + export interface Schema$Chokepoint { + /** + * List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + */ + relatedFindings?: string[] | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -655,43 +673,6 @@ export namespace securitycenter_v1beta1 { */ version?: string | null; } - /** - * Result containing the properties and count of a ComplianceSnapshot request. - */ - export interface Schema$ComplianceSnapshot { - /** - * The category of Findings matching. - */ - category?: string | null; - /** - * The cloud provider for the compliance snapshot. - */ - cloudProvider?: string | null; - /** - * The compliance standard (ie CIS). - */ - complianceStandard?: string | null; - /** - * The compliance version (ie 1.3) in CIS 1.3. - */ - complianceVersion?: string | null; - /** - * Total count of findings for the given properties. - */ - count?: string | null; - /** - * The leaf container resource name that is closest to the snapshot. - */ - leafContainerResource?: string | null; - /** - * The compliance snapshot name. Format: //sources//complianceSnapshots/ - */ - name?: string | null; - /** - * The snapshot time of the snapshot. - */ - snapshotTime?: string | null; - } /** * Contains information about the IP connection associated with the finding. */ @@ -1121,6 +1102,10 @@ export namespace securitycenter_v1beta1 { * Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. */ access?: Schema$Access; + /** + * AffectedResources associated with the finding. + */ + affectedResources?: Schema$AffectedResources; /** * Represents an application associated with the finding. */ @@ -1141,6 +1126,10 @@ export namespace securitycenter_v1beta1 { * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ category?: string | null; + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. + */ + chokepoint?: Schema$Chokepoint; /** * Fields related to Cloud Armor findings. */ @@ -2156,6 +2145,15 @@ export namespace securitycenter_v1beta1 { */ confidence?: number | null; } + /** + * Details about resources affected by this finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2AffectedResources { + /** + * The count of resources affected by the finding. + */ + count?: string | null; + } /** * Allowed IP rule. */ @@ -2468,6 +2466,15 @@ export namespace securitycenter_v1beta1 { * The response to a BulkMute request. Contains the LRO information. */ export interface Schema$GoogleCloudSecuritycenterV2BulkMuteFindingsResponse {} + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + */ + export interface Schema$GoogleCloudSecuritycenterV2Chokepoint { + /** + * List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + */ + relatedFindings?: string[] | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -3022,6 +3029,10 @@ export namespace securitycenter_v1beta1 { * Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. */ access?: Schema$GoogleCloudSecuritycenterV2Access; + /** + * AffectedResources associated with the finding. + */ + affectedResources?: Schema$GoogleCloudSecuritycenterV2AffectedResources; /** * Represents an application associated with the finding. */ @@ -3042,6 +3053,10 @@ export namespace securitycenter_v1beta1 { * Immutable. The additional taxonomy group within findings from a given source. Example: "XSS_FLASH_INJECTION" */ category?: string | null; + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. + */ + chokepoint?: Schema$GoogleCloudSecuritycenterV2Chokepoint; /** * Fields related to Cloud Armor findings. */ diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index f553cddaadb..b530421d4e9 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -219,6 +219,15 @@ export namespace securitycenter_v1beta2 { */ confidence?: number | null; } + /** + * Details about resources affected by this finding. + */ + export interface Schema$AffectedResources { + /** + * The count of resources affected by the finding. + */ + count?: string | null; + } /** * Allowed IP rule. */ @@ -469,6 +478,15 @@ export namespace securitycenter_v1beta2 { */ storagePool?: string | null; } + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + */ + export interface Schema$Chokepoint { + /** + * List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + */ + relatedFindings?: string[] | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -570,43 +588,6 @@ export namespace securitycenter_v1beta2 { */ version?: string | null; } - /** - * Result containing the properties and count of a ComplianceSnapshot request. - */ - export interface Schema$ComplianceSnapshot { - /** - * The category of Findings matching. - */ - category?: string | null; - /** - * The cloud provider for the compliance snapshot. - */ - cloudProvider?: string | null; - /** - * The compliance standard (ie CIS). - */ - complianceStandard?: string | null; - /** - * The compliance version (ie 1.3) in CIS 1.3. - */ - complianceVersion?: string | null; - /** - * Total count of findings for the given properties. - */ - count?: string | null; - /** - * The leaf container resource name that is closest to the snapshot. - */ - leafContainerResource?: string | null; - /** - * The compliance snapshot name. Format: //sources//complianceSnapshots/ - */ - name?: string | null; - /** - * The snapshot time of the snapshot. - */ - snapshotTime?: string | null; - } /** * Configuration of a module. */ @@ -1108,6 +1089,10 @@ export namespace securitycenter_v1beta2 { * Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. */ access?: Schema$Access; + /** + * AffectedResources associated with the finding. + */ + affectedResources?: Schema$AffectedResources; /** * Represents an application associated with the finding. */ @@ -1128,6 +1113,10 @@ export namespace securitycenter_v1beta2 { * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ category?: string | null; + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. + */ + chokepoint?: Schema$Chokepoint; /** * Fields related to Cloud Armor findings. */ @@ -2067,6 +2056,15 @@ export namespace securitycenter_v1beta2 { */ confidence?: number | null; } + /** + * Details about resources affected by this finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2AffectedResources { + /** + * The count of resources affected by the finding. + */ + count?: string | null; + } /** * Allowed IP rule. */ @@ -2379,6 +2377,15 @@ export namespace securitycenter_v1beta2 { * The response to a BulkMute request. Contains the LRO information. */ export interface Schema$GoogleCloudSecuritycenterV2BulkMuteFindingsResponse {} + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + */ + export interface Schema$GoogleCloudSecuritycenterV2Chokepoint { + /** + * List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + */ + relatedFindings?: string[] | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -2933,6 +2940,10 @@ export namespace securitycenter_v1beta2 { * Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. */ access?: Schema$GoogleCloudSecuritycenterV2Access; + /** + * AffectedResources associated with the finding. + */ + affectedResources?: Schema$GoogleCloudSecuritycenterV2AffectedResources; /** * Represents an application associated with the finding. */ @@ -2953,6 +2964,10 @@ export namespace securitycenter_v1beta2 { * Immutable. The additional taxonomy group within findings from a given source. Example: "XSS_FLASH_INJECTION" */ category?: string | null; + /** + * Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. + */ + chokepoint?: Schema$GoogleCloudSecuritycenterV2Chokepoint; /** * Fields related to Cloud Armor findings. */ @@ -5000,7 +5015,7 @@ export namespace securitycenter_v1beta2 { suggestedUpgradeVersion?: string | null; } /** - * Resource capturing the settings for Security Center. Next ID: 12 + * Resource capturing the settings for Security Center. */ export interface Schema$SecurityCenterSettings { /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index e03f3ac5903..34536a2ff03 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -456,7 +456,7 @@ export namespace servicecontrol_v1 { */ export interface Schema$Distribution { /** - * The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted. + * The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N]` is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted. */ bucketCounts?: string[] | null; /** diff --git a/src/apis/servicedirectory/v1.ts b/src/apis/servicedirectory/v1.ts index dc5c11fead5..38b069d1484 100644 --- a/src/apis/servicedirectory/v1.ts +++ b/src/apis/servicedirectory/v1.ts @@ -601,6 +601,10 @@ export namespace servicedirectory_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/servicedirectory/v1beta1.ts b/src/apis/servicedirectory/v1beta1.ts index 77096020be8..f79596a9acc 100644 --- a/src/apis/servicedirectory/v1beta1.ts +++ b/src/apis/servicedirectory/v1beta1.ts @@ -625,6 +625,10 @@ export namespace servicedirectory_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 40bdc260961..98b6c6f074d 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -1035,7 +1035,7 @@ export namespace servicemanagement_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; /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 6a139a10bb1..3f3264e0a63 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -3742,7 +3742,7 @@ export namespace serviceusage_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Get extends StandardParameters { /** - * The resource name of the quota limit. An example name would be: `projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests` + * The resource name of the quota. An example name would be: `projects/123/services/serviceusage.googleapis.com/consumerQuotaMetrics/serviceusage.googleapis.com%2Fmutate_requests` */ name?: string; /** diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 3c5039f3f16..e6a26d5a19f 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -303,6 +303,15 @@ export namespace sheets_v4 { */ slicer?: Schema$Slicer; } + /** + * Adds a new table to the spreadsheet. + */ + export interface Schema$AddTableRequest { + /** + * Required. The table to add. + */ + table?: Schema$Table; + } /** * Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary. */ @@ -319,6 +328,10 @@ export namespace sheets_v4 { * The sheet ID to append the data to. */ sheetId?: number | null; + /** + * The ID of the table to append data to. The data will be only appended to the table body. This field also takes precedence over the `sheet_id` field. + */ + tableId?: string | null; } /** * Appends rows or columns to the end of a sheet. @@ -631,6 +644,10 @@ export namespace sheets_v4 { * The sort order per column. Later specifications are used when values are equal in the earlier specifications. */ sortSpecs?: Schema$SortSpec[]; + /** + * The table this filter is backed by, if any. When writing, only one of range or table_id may be set. + */ + tableId?: string | null; } /** * Style override settings for a single series data point. @@ -667,7 +684,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchClearValuesByDataFilterResponse { /** - * The ranges that were cleared, in [A1 notation](/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. + * The ranges that were cleared, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. */ clearedRanges?: string[] | null; /** @@ -680,7 +697,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchClearValuesRequest { /** - * The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell). + * The ranges to clear, in [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). */ ranges?: string[] | null; } @@ -1507,7 +1524,7 @@ export namespace sheets_v4 { */ export interface Schema$ColorStyle { /** - * RGB color. The [`alpha`](/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't generally supported. + * RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't generally supported. */ rgbColor?: Schema$Color; /** @@ -2145,6 +2162,15 @@ export namespace sheets_v4 { */ sheetId?: number | null; } + /** + * Removes the table with the given ID from the spreadsheet. + */ + export interface Schema$DeleteTableRequest { + /** + * The ID of the table to delete. + */ + tableId?: string | null; + } /** * Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too. */ @@ -2504,17 +2530,21 @@ export namespace sheets_v4 { */ filterViewId?: number | null; /** - * The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set. + * The named range this filter view is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. */ namedRangeId?: string | null; /** - * The range this filter view covers. When writing, only one of range or named_range_id may be set. + * The range this filter view covers. When writing, only one of range or named_range_id or table_id may be set. */ range?: Schema$GridRange; /** * The sort order per column. Later specifications are used when values are equal in the earlier specifications. */ sortSpecs?: Schema$SortSpec[]; + /** + * The table this filter view is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. + */ + tableId?: string | null; /** * The name of the filter view. */ @@ -2594,6 +2624,10 @@ export namespace sheets_v4 { * The DataFilters used to select which ranges to retrieve from the spreadsheet. */ dataFilters?: Schema$DataFilter[]; + /** + * True if tables should be excluded in the banded ranges. False if not set. + */ + excludeTablesInBandedRanges?: boolean | null; /** * True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */ @@ -2996,7 +3030,7 @@ export namespace sheets_v4 { */ export interface Schema$NumberFormat { /** - * Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the [Date and Number Formats guide](/sheets/api/guides/formats) for more information about the supported patterns. + * Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for more information about the supported patterns. */ pattern?: string | null; /** @@ -3368,7 +3402,7 @@ export namespace sheets_v4 { */ editors?: Schema$Editors; /** - * The named range this protected range is backed by, if any. When writing, only one of range or named_range_id may be set. + * The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. */ namedRangeId?: string | null; /** @@ -3376,13 +3410,17 @@ export namespace sheets_v4 { */ protectedRangeId?: number | null; /** - * The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id may be set. + * The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id or table_id may be set. */ range?: Schema$GridRange; /** * True if the user who requested this protected range can edit the protected area. This field is read-only. */ requestingUserCanEdit?: boolean | null; + /** + * The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. + */ + tableId?: string | null; /** * The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets. */ @@ -3518,6 +3556,10 @@ export namespace sheets_v4 { * Adds a slicer. */ addSlicer?: Schema$AddSlicerRequest; + /** + * Adds a table. + */ + addTable?: Schema$AddTableRequest; /** * Appends cells after the last row with data in a sheet. */ @@ -3606,6 +3648,10 @@ export namespace sheets_v4 { * Deletes a sheet. */ deleteSheet?: Schema$DeleteSheetRequest; + /** + * A request for deleting a table. + */ + deleteTable?: Schema$DeleteTableRequest; /** * Duplicates a filter view. */ @@ -3742,6 +3788,10 @@ export namespace sheets_v4 { * Updates the spreadsheet's properties. */ updateSpreadsheetProperties?: Schema$UpdateSpreadsheetPropertiesRequest; + /** + * Updates a table. + */ + updateTable?: Schema$UpdateTableRequest; } /** * A single response from an update. @@ -3990,6 +4040,10 @@ export namespace sheets_v4 { * The slicers on this sheet. */ slicers?: Schema$Slicer[]; + /** + * The tables on this sheet. + */ + tables?: Schema$Table[]; } /** * Properties of a sheet. @@ -4244,6 +4298,82 @@ export namespace sheets_v4 { */ themeColors?: Schema$ThemeColorPair[]; } + /** + * A table. + */ + export interface Schema$Table { + /** + * The table column properties. + */ + columnProperties?: Schema$TableColumnProperties[]; + /** + * The table name. This is unique to all tables in the same spreadsheet. + */ + name?: string | null; + /** + * The table range. + */ + range?: Schema$GridRange; + /** + * The table rows properties. + */ + rowsProperties?: Schema$TableRowsProperties; + /** + * The id of the table. + */ + tableId?: string | null; + } + /** + * A data validation rule for a column in a table. + */ + export interface Schema$TableColumnDataValidationRule { + /** + * The condition that data in the cell must match. Valid only if the [BooleanCondition.type] is ONE_OF_LIST. + */ + condition?: Schema$BooleanCondition; + } + /** + * The table column. + */ + export interface Schema$TableColumnProperties { + /** + * The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet. + */ + columnIndex?: number | null; + /** + * The column name. + */ + columnName?: string | null; + /** + * The column type. + */ + columnType?: string | null; + /** + * The column data validation rule. Only set for dropdown column type. + */ + dataValidationRule?: Schema$TableColumnDataValidationRule; + } + /** + * The table row properties. + */ + export interface Schema$TableRowsProperties { + /** + * The first color that is alternating. If this field is set, the first banded row is filled with the specified color. Otherwise, the first banded row is filled with a default color. + */ + firstBandColorStyle?: Schema$ColorStyle; + /** + * The color of the last row. If this field is not set a footer is not added, the last row is filled with either first_band_color_style or second_band_color_style, depending on the color of the previous row. If updating an existing table without a footer to have a footer, the range will be expanded by 1 row. If updating an existing table with a footer and removing a footer, the range will be shrunk by 1 row. + */ + footerColorStyle?: Schema$ColorStyle; + /** + * The color of the header row. If this field is set, the header row is filled with the specified color. Otherwise, the header row is filled with a default color. + */ + headerColorStyle?: Schema$ColorStyle; + /** + * The second color that is alternating. If this field is set, the second banded row is filled with the specified color. Otherwise, the second banded row is filled with a default color. + */ + secondBandColorStyle?: Schema$ColorStyle; + } /** * The format of a run of text in a cell. Absent values indicate that the field isn't specified. */ @@ -4825,6 +4955,19 @@ export namespace sheets_v4 { */ properties?: Schema$SpreadsheetProperties; } + /** + * Updates a table in the spreadsheet. + */ + export interface Schema$UpdateTableRequest { + /** + * Required. The fields that should be updated. At least one field must be specified. The root `table` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. + */ + fields?: string | null; + /** + * Required. The table to update. + */ + table?: Schema$Table; + } /** * The response when updating a range of values by a data filter in a spreadsheet. */ @@ -4846,7 +4989,7 @@ export namespace sheets_v4 { */ updatedData?: Schema$ValueRange; /** - * The range (in [A1 notation](/sheets/api/guides/concepts#cell)) that updates were applied to. + * The range (in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell)) that updates were applied to. */ updatedRange?: string | null; /** @@ -4892,7 +5035,7 @@ export namespace sheets_v4 { */ majorDimension?: string | null; /** - * The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. + * The range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */ range?: string | null; /** @@ -5210,7 +5353,7 @@ export namespace sheets_v4 { } /** - * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges. + * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5297,7 +5440,7 @@ export namespace sheets_v4 { } /** - * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. + * Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5404,6 +5547,10 @@ export namespace sheets_v4 { requestBody?: Schema$Spreadsheet; } export interface Params$Resource$Spreadsheets$Get extends StandardParameters { + /** + * True if tables should be excluded in the banded ranges. False if not set. + */ + excludeTablesInBandedRanges?: boolean; /** * True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */ @@ -5768,7 +5915,7 @@ export namespace sheets_v4 { } /** - * Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. + * Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6715,7 +6862,7 @@ export namespace sheets_v4 { */ insertDataOption?: string; /** - * The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. + * The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. */ range?: string; /** @@ -6775,7 +6922,7 @@ export namespace sheets_v4 { */ majorDimension?: string; /** - * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from. + * The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from. */ ranges?: string[]; /** @@ -6826,7 +6973,7 @@ export namespace sheets_v4 { export interface Params$Resource$Spreadsheets$Values$Clear extends StandardParameters { /** - * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear. + * The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear. */ range?: string; /** @@ -6850,7 +6997,7 @@ export namespace sheets_v4 { */ majorDimension?: string; /** - * The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from. + * The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from. */ range?: string; /** @@ -6869,7 +7016,7 @@ export namespace sheets_v4 { */ includeValuesInResponse?: boolean; /** - * The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update. + * The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update. */ range?: string; /** diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index e479dae0927..24d02dc206e 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -1734,7 +1734,7 @@ export namespace slides_v1 { type?: string | null; } /** - * 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). + * 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/workspace/slides/api/guides/transform). */ export interface Schema$Shape { /** @@ -1916,6 +1916,10 @@ export namespace slides_v1 { * Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive. */ matchCase?: boolean | null; + /** + * Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching. + */ + searchByRegex?: boolean | null; /** * The text to search for in the shape or table. */ @@ -3061,7 +3065,7 @@ export namespace slides_v1 { } /** - * Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](/slides/limits) for quota purposes. + * Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](https://developers.google.com/workspace/slides/limits) for quota purposes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index 337c4bfd5bb..245c677041c 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -246,7 +246,7 @@ export namespace sqladmin_v1 { */ backupRun?: string | null; /** - * Output only. The database version of the instance of when this backup was made. + * Output only. The database version of the instance of at the time this backup was made. */ databaseVersion?: string | null; /** @@ -423,7 +423,7 @@ export namespace sqladmin_v1 { */ backupKind?: string | null; /** - * Output only. The instance database version when this backup was made. + * Output only. The instance database version at the time this backup was made. */ databaseVersion?: string | null; /** @@ -574,38 +574,14 @@ export namespace sqladmin_v1 { * 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. @@ -621,23 +597,23 @@ export namespace sqladmin_v1 { value?: string | null; } /** - * Details of a single node of a read pool. + * Details of a single read pool node of a read pool. */ export interface Schema$ConnectPoolNodeConfig { /** - * Output only. The DNS name of the node. + * Output only. The DNS name of the read pool node. */ dnsName?: string | null; /** - * Output only. The list of DNS names used by this node. + * Output only. The list of DNS names used by this read pool node. */ dnsNames?: Schema$DnsNameMapping[]; /** - * Output only. Mappings containing IP addresses that can be used to connect to the node. + * Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */ ipAddresses?: Schema$IpMapping[]; /** - * Output only. The name of the node. Doesn't include the project ID. + * Output only. The name of the read pool node. Doesn't include the project ID. */ name?: string | null; } @@ -674,11 +650,11 @@ export namespace sqladmin_v1 { */ kind?: string | null; /** - * The number of nodes in a read pool. + * The number of read pool nodes in a read pool. */ nodeCount?: number | null; /** - * Output only. Entries containing information about each node of the read pool. + * Output only. Entries containing information about each read pool node of the read pool. */ nodes?: Schema$ConnectPoolNodeConfig[]; /** @@ -850,11 +826,11 @@ export namespace sqladmin_v1 { */ name?: string | null; /** - * The number of nodes in a read pool. + * The number of read pool nodes in a read pool. */ nodeCount?: number | null; /** - * Output only. Entries containing information about each node of the read pool. + * Output only. Entries containing information about each read pool node of the read pool. */ nodes?: Schema$PoolNodeConfig[]; /** @@ -1160,7 +1136,7 @@ export namespace sqladmin_v1 { */ kind?: string | null; /** - * Option for export offload. + * Whether to perform a serverless export. */ offload?: boolean | null; /** @@ -2082,31 +2058,31 @@ export namespace sqladmin_v1 { targetSizeGb?: string | null; } /** - * Details of a single node of a read pool. + * Details of a single read pool node of a read pool. */ export interface Schema$PoolNodeConfig { /** - * Output only. The DNS name of the node. + * Output only. The DNS name of the read pool node. */ dnsName?: string | null; /** - * Output only. The list of DNS names used by this node. + * Output only. The list of DNS names used by this read pool node. */ dnsNames?: Schema$DnsNameMapping[]; /** - * Output only. The serving zone of the node. + * Output only. The zone of the read pool node. */ gceZone?: string | null; /** - * Output only. Mappings containing IP addresses that can be used to connect to the node. + * Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */ ipAddresses?: Schema$IpMapping[]; /** - * Output only. The name of the node, to be used for retrieving metrics and logs for the node. + * Output only. The name of the read pool node, to be used for retrieving metrics and logs. */ name?: string | null; /** - * Output only. The current state of the node. + * Output only. The current state of the read pool node. */ state?: string | null; } @@ -2345,7 +2321,7 @@ export namespace sqladmin_v1 { */ enableDataplexIntegration?: boolean | null; /** - * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. + * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances. */ enableGoogleMlIntegration?: boolean | null; /** @@ -2860,6 +2836,10 @@ export namespace sqladmin_v1 { * Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. */ host?: string | null; + /** + * Indicates if user is active for IAM Authentication. + */ + iamStatus?: string | null; /** * The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL. */ diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 02c47e9d45a..af91f1cdd8c 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -246,7 +246,7 @@ export namespace sqladmin_v1beta4 { */ backupRun?: string | null; /** - * Output only. The database version of the instance of when this backup was made. + * Output only. The database version of the instance of at the time this backup was made. */ databaseVersion?: string | null; /** @@ -423,7 +423,7 @@ export namespace sqladmin_v1beta4 { */ backupKind?: string | null; /** - * Output only. The instance database version when this backup was made. + * Output only. The instance database version at the time this backup was made. */ databaseVersion?: string | null; /** @@ -574,38 +574,14 @@ export namespace sqladmin_v1beta4 { * 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. @@ -621,23 +597,23 @@ export namespace sqladmin_v1beta4 { value?: string | null; } /** - * Details of a single node of a read pool. + * Details of a single read pool node of a read pool. */ export interface Schema$ConnectPoolNodeConfig { /** - * Output only. The DNS name of the node. + * Output only. The DNS name of the read pool node. */ dnsName?: string | null; /** - * Output only. The list of DNS names used by this instance. + * Output only. The list of DNS names used by this read pool node. */ dnsNames?: Schema$DnsNameMapping[]; /** - * Output only. Mappings containing IP addresses that can be used to connect to the node. + * Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */ ipAddresses?: Schema$IpMapping[]; /** - * Output only. The name of the node. Doesn't include the project ID. + * Output only. The name of the read pool node. Doesn't include the project ID. */ name?: string | null; } @@ -674,11 +650,11 @@ export namespace sqladmin_v1beta4 { */ kind?: string | null; /** - * The number of nodes in a read pool. + * The number of read pool nodes in a read pool. */ nodeCount?: number | null; /** - * Output only. Entries containing information about each node of the read pool. + * Output only. Entries containing information about each read pool node of the read pool. */ nodes?: Schema$ConnectPoolNodeConfig[]; /** @@ -850,11 +826,11 @@ export namespace sqladmin_v1beta4 { */ name?: string | null; /** - * The number of nodes in a read pool. + * The number of read pool nodes in a read pool. */ nodeCount?: number | null; /** - * Output only. Entries containing information about each node of the read pool. + * Output only. Entries containing information about each read pool node of the read pool. */ nodes?: Schema$PoolNodeConfig[]; /** @@ -1163,7 +1139,7 @@ export namespace sqladmin_v1beta4 { */ kind?: string | null; /** - * Option for export offload. + * Whether to perform a serverless export. */ offload?: boolean | null; /** @@ -2085,31 +2061,31 @@ export namespace sqladmin_v1beta4 { targetSizeGb?: string | null; } /** - * Details of a single node of a read pool. + * Details of a single read pool node of a read pool. */ export interface Schema$PoolNodeConfig { /** - * Output only. The DNS name of the node. + * Output only. The DNS name of the read pool node. */ dnsName?: string | null; /** - * Output only. The list of DNS names used by this node. + * Output only. The list of DNS names used by this read pool node. */ dnsNames?: Schema$DnsNameMapping[]; /** - * Output only. The serving zone of the node. + * Output only. The zone of the read pool node. */ gceZone?: string | null; /** - * Output only. Mappings containing IP addresses that can be used to connect to the node. + * Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */ ipAddresses?: Schema$IpMapping[]; /** - * Output only. The name of the node, to be used for retrieving metrics and logs for the node. + * Output only. The name of the read pool node, to be used for retrieving metrics and logs. */ name?: string | null; /** - * Output only. The current state of the node. + * Output only. The current state of the read pool node. */ state?: string | null; } @@ -2348,7 +2324,7 @@ export namespace sqladmin_v1beta4 { */ enableDataplexIntegration?: boolean | null; /** - * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. + * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances. */ enableGoogleMlIntegration?: boolean | null; /** @@ -2857,6 +2833,10 @@ export namespace sqladmin_v1beta4 { * Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. */ host?: string | null; + /** + * Indicates if user is active for IAM Authentication. + */ + iamStatus?: string | null; /** * The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL. */ diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index a037b5f64c8..3d0681839aa 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -9142,6 +9142,10 @@ export namespace storage_v1 { * Makes the operation conditional on whether the source object's current metageneration does not match the given value. `ifSourceMetagenerationMatch` and `ifSourceMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request. */ ifSourceMetagenerationNotMatch?: string; + /** + * Set of properties to return. Defaults to noAcl. + */ + projection?: string; /** * Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). */ diff --git a/src/apis/storagebatchoperations/README.md b/src/apis/storagebatchoperations/README.md new file mode 100644 index 00000000000..725a8f52fbc --- /dev/null +++ b/src/apis/storagebatchoperations/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# storagebatchoperations + +> + +## Installation + +```sh +$ npm install @googleapis/storagebatchoperations +``` + +## 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/storagebatchoperations/classes/Storagebatchoperations.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/storagebatchoperations/index.ts b/src/apis/storagebatchoperations/index.ts new file mode 100644 index 00000000000..753a39adaa0 --- /dev/null +++ b/src/apis/storagebatchoperations/index.ts @@ -0,0 +1,50 @@ +// 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 {storagebatchoperations_v1} from './v1'; + +export const VERSIONS = { + v1: storagebatchoperations_v1.Storagebatchoperations, +}; + +export function storagebatchoperations( + version: 'v1' +): storagebatchoperations_v1.Storagebatchoperations; +export function storagebatchoperations( + options: storagebatchoperations_v1.Options +): storagebatchoperations_v1.Storagebatchoperations; +export function storagebatchoperations< + T = storagebatchoperations_v1.Storagebatchoperations, +>( + this: GoogleConfigurable, + versionOrOptions: 'v1' | storagebatchoperations_v1.Options +) { + return getAPI('storagebatchoperations', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {storagebatchoperations_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/storagebatchoperations/package.json b/src/apis/storagebatchoperations/package.json new file mode 100644 index 00000000000..a743aabf2f7 --- /dev/null +++ b/src/apis/storagebatchoperations/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/storagebatchoperations", + "version": "0.1.0", + "description": "storagebatchoperations", + "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/storagebatchoperations/tsconfig.json b/src/apis/storagebatchoperations/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/storagebatchoperations/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/storagebatchoperations/v1.ts b/src/apis/storagebatchoperations/v1.ts new file mode 100644 index 00000000000..5c965ab5c62 --- /dev/null +++ b/src/apis/storagebatchoperations/v1.ts @@ -0,0 +1,1668 @@ +// 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 storagebatchoperations_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; + } + + /** + * Storage Batch Operations API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const storagebatchoperations = google.storagebatchoperations('v1'); + * ``` + */ + export class Storagebatchoperations { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Describes configuration of a single bucket and its objects to be transformed. + */ + export interface Schema$Bucket { + /** + * Required. Bucket name for the objects to be transformed. + */ + bucket?: string | null; + /** + * Specifies objects in a manifest file. + */ + manifest?: Schema$Manifest; + /** + * Specifies objects matching a prefix set. + */ + prefixList?: Schema$PrefixList; + } + /** + * Describes list of buckets and their objects to be transformed. + */ + export interface Schema$BucketList { + /** + * Required. List of buckets and their objects to be transformed. Currently, only one bucket configuration is supported. If multiple buckets are specified, an error will be returned. + */ + buckets?: Schema$Bucket[]; + } + /** + * Message for Job to Cancel + */ + export interface Schema$CancelJobRequest { + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Message for response to cancel Job. + */ + export interface Schema$CancelJobResponse {} + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * Describes details about the progress of the job. + */ + export interface Schema$Counters { + /** + * Output only. Number of objects failed. + */ + failedObjectCount?: string | null; + /** + * Output only. Number of objects completed. + */ + succeededObjectCount?: string | null; + /** + * Output only. Number of objects listed. + */ + totalObjectCount?: string | null; + } + /** + * Describes options to delete an object. + */ + export interface Schema$DeleteObject { + /** + * Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation. + */ + permanentObjectDeletionEnabled?: boolean | null; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * An entry describing an error that has occurred. + */ + export interface Schema$ErrorLogEntry { + /** + * Optional. Output only. At most 5 error log entries are recorded for a given error code for a job. + */ + errorDetails?: string[] | null; + /** + * Required. Output only. Object URL. e.g. gs://my_bucket/object.txt + */ + objectUri?: string | null; + } + /** + * A summary of errors by error code, plus a count and sample error log entries. + */ + export interface Schema$ErrorSummary { + /** + * Required. The canonical error code. + */ + errorCode?: string | null; + /** + * Required. Number of errors encountered per `error_code`. + */ + errorCount?: string | null; + /** + * Required. Sample error logs. + */ + errorLogEntries?: Schema$ErrorLogEntry[]; + } + /** + * The Storage Batch Operations Job description. + */ + export interface Schema$Job { + /** + * Specifies a list of buckets and their objects to be transformed. + */ + bucketList?: Schema$BucketList; + /** + * Output only. The time that the job was completed. + */ + completeTime?: string | null; + /** + * Output only. Information about the progress of the job. + */ + counters?: Schema$Counters; + /** + * Output only. The time that the job was created. + */ + createTime?: string | null; + /** + * Delete objects. + */ + deleteObject?: Schema$DeleteObject; + /** + * Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. + */ + description?: string | null; + /** + * Output only. Summarizes errors encountered with sample error log entries. + */ + errorSummaries?: Schema$ErrorSummary[]; + /** + * Optional. Logging configuration. + */ + loggingConfig?: Schema$LoggingConfig; + /** + * Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project\}/locations/global/jobs/{job_id\} . For example: "projects/123456/locations/global/jobs/job01". + */ + name?: string | null; + /** + * Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time. + */ + putMetadata?: Schema$PutMetadata; + /** + * Changes object hold status. + */ + putObjectHold?: Schema$PutObjectHold; + /** + * Rewrite the object and updates metadata like KMS key. + */ + rewriteObject?: Schema$RewriteObject; + /** + * Output only. The time that the job was scheduled. + */ + scheduleTime?: string | null; + /** + * Output only. State of the job. + */ + state?: string | null; + } + /** + * Message for response to listing Jobs + */ + export interface Schema$ListJobsResponse { + /** + * A list of storage batch jobs. + */ + jobs?: Schema$Job[]; + /** + * A token identifying a page of results. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * Specifies the Cloud Logging behavior. + */ + export interface Schema$LoggingConfig { + /** + * Required. Specifies the actions to be logged. + */ + logActions?: string[] | null; + /** + * Required. States in which Action are logged.If empty, no logs are generated. + */ + logActionStates?: string[] | null; + } + /** + * Describes list of objects to be transformed. + */ + export interface Schema$Manifest { + /** + * Required. `manifest_location` must contain the manifest source file that is a CSV file in a Google Cloud Storage bucket. Each row in the file must include the object details i.e. BucketId and Name. Generation may optionally be specified. When it is not specified the live object is acted upon. `manifest_location` should either be 1) An absolute path to the object in the format of `gs://bucket_name/path/file_name.csv`. 2) An absolute path with a single wildcard character in the file name, for example `gs://bucket_name/path/file_name*.csv`. If manifest location is specified with a wildcard, objects in all manifest files matching the pattern will be acted upon. + */ + manifestLocation?: 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. The Job associated with the operation. + */ + job?: Schema$Job; + /** + * Output only. The unique operation resource name. Format: projects/{project\}/locations/global/operations/{operation\}. + */ + operation?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + } + /** + * Describes prefixes of objects to be transformed. + */ + export interface Schema$PrefixList { + /** + * Optional. Include prefixes of the objects to be transformed. * Supports full object name * Supports prefix of the object name * Wildcards are not supported * Supports empty string for all objects in a bucket. + */ + includedObjectPrefixes?: string[] | null; + } + /** + * Describes options for object metadata update. + */ + export interface Schema$PutMetadata { + /** + * Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data. + */ + cacheControl?: string | null; + /** + * Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation. + */ + contentDisposition?: string | null; + /** + * Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding. + */ + contentEncoding?: string | null; + /** + * Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language. + */ + contentLanguage?: string | null; + /** + * Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type + */ + contentType?: string | null; + /** + * Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata + */ + customMetadata?: {[key: string]: string} | null; + /** + * Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time. + */ + customTime?: string | null; + } + /** + * Describes options to update object hold. + */ + export interface Schema$PutObjectHold { + /** + * Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period. + */ + eventBasedHold?: string | null; + /** + * Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced. + */ + temporaryHold?: string | null; + } + /** + * Describes options for object rewrite. + */ + export interface Schema$RewriteObject { + /** + * Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{key\} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key. + */ + kmsKey?: 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; + } + + 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; + jobs: Resource$Projects$Locations$Jobs; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.jobs = new Resource$Projects$Locations$Jobs(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://storagebatchoperations.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://storagebatchoperations.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 { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; + /** + * 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$Jobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels a batch 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://storagebatchoperations.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a batch job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Jobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Jobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://storagebatchoperations.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/jobs').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 batch 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. + */ + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Jobs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Jobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://storagebatchoperations.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 batch 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. + */ + get( + params: Params$Resource$Projects$Locations$Jobs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Jobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Jobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Jobs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Jobs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Jobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://storagebatchoperations.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 Jobs in a given project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Jobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Jobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Jobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Jobs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Jobs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Jobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://storagebatchoperations.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Jobs$Cancel + extends StandardParameters { + /** + * Required. The `name` of the job to cancel. Format: projects/{project_id\}/locations/global/jobs/{job_id\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelJobRequest; + } + export interface Params$Resource$Projects$Locations$Jobs$Create + extends StandardParameters { + /** + * Required. The optional `job_id` for this Job . If not specified, an id is generated. `job_id` should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123. + */ + jobId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Job; + } + export interface Params$Resource$Projects$Locations$Jobs$Delete + extends StandardParameters { + /** + * Required. The `name` of the job to delete. Format: projects/{project_id\}/locations/global/jobs/{job_id\} . + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$Get + extends StandardParameters { + /** + * Required. `name` of the job to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\} . + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$List + extends StandardParameters { + /** + * Optional. Filters results as defined by https://google.aip.dev/160. + */ + filter?: string; + /** + * Optional. Field to sort by. Supported fields are name, create_time. + */ + orderBy?: string; + /** + * Optional. The list page size. default page size is 100. + */ + pageSize?: number; + /** + * Optional. The list page token. + */ + pageToken?: string; + /** + * Required. Format: projects/{project_id\}/locations/global. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://storagebatchoperations.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://storagebatchoperations.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://storagebatchoperations.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://storagebatchoperations.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/storagebatchoperations/webpack.config.js b/src/apis/storagebatchoperations/webpack.config.js new file mode 100644 index 00000000000..9d10c92501b --- /dev/null +++ b/src/apis/storagebatchoperations/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: 'Storagebatchoperations', + filename: 'storagebatchoperations.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index 74dd01efdb6..ca972dda161 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -261,10 +261,6 @@ export namespace tagmanager_v1 { * The folders in the container that this version was taken from. */ folder?: Schema$Folder[]; - /** - * The macros in the container that this version was taken from. - */ - macro?: Schema$Macro[]; /** * Container version display name. */ @@ -273,10 +269,6 @@ export namespace tagmanager_v1 { * User notes on how to apply this container version in the container. */ notes?: string | null; - /** - * The rules in the container that this version was taken from. - */ - rule?: Schema$Rule[]; /** * The tags in the container that this version was taken from. */ @@ -314,14 +306,6 @@ export namespace tagmanager_v1 { * Container version display name. */ name?: string | null; - /** - * Number of macros in the container version. - */ - numMacros?: string | null; - /** - * Number of rules in the container version. - */ - numRules?: string | null; /** * Number of tags in the container version. */ @@ -542,63 +526,6 @@ export namespace tagmanager_v1 { */ variables?: Schema$Variable[]; } - /** - * Represents a Google Tag Manager Macro. - */ - export interface Schema$Macro { - /** - * GTM Account ID. - */ - accountId?: string | null; - /** - * GTM Container ID. - */ - 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. - */ - 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. - */ - enablingRuleId?: string[] | null; - /** - * The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - */ - fingerprint?: string | null; - /** - * The Macro ID uniquely identifies the GTM Macro. - */ - macroId?: string | null; - /** - * Macro display name. - */ - name?: string | null; - /** - * User notes on how to apply this macro in the container. - */ - notes?: string | null; - /** - * The macro's parameters. - */ - parameter?: Schema$Parameter[]; - /** - * Parent folder id. - */ - parentFolderId?: string | null; - /** - * The end timestamp in milliseconds to schedule a macro. - */ - scheduleEndMs?: string | null; - /** - * The start timestamp in milliseconds to schedule a macro. - */ - scheduleStartMs?: string | null; - /** - * GTM Macro Type. - */ - type?: string | null; - } /** * Represents a Google Tag Manager Parameter. */ @@ -637,39 +564,6 @@ export namespace tagmanager_v1 { */ containerVersion?: Schema$ContainerVersion; } - /** - * Represents a Google Tag Manager Rule. - */ - export interface Schema$Rule { - /** - * GTM Account ID. - */ - accountId?: string | null; - /** - * The list of conditions that make up this rule (implicit AND between them). - */ - condition?: Schema$Condition[]; - /** - * GTM Container ID. - */ - containerId?: string | null; - /** - * The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - */ - fingerprint?: string | null; - /** - * Rule display name. - */ - name?: string | null; - /** - * User notes on how to apply this rule in the container. - */ - notes?: string | null; - /** - * The Rule ID uniquely identifies the GTM Rule. - */ - ruleId?: string | null; - } export interface Schema$SetupTag { /** * If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status. @@ -688,10 +582,6 @@ export namespace tagmanager_v1 { * GTM Account ID. */ accountId?: string | null; - /** - * 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. */ @@ -704,10 +594,6 @@ export namespace tagmanager_v1 { * The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. */ 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. - */ - 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. */ diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 6526485e360..154b9ca28b7 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -521,14 +521,6 @@ export namespace tagmanager_v2 { * Number of Google tag configs in the container version. */ numGtagConfigs?: string | null; - /** - * Number of macros in the container version. - */ - numMacros?: string | null; - /** - * Number of rules in the container version. - */ - numRules?: string | null; /** * Number of tags in the container version. */ @@ -1356,10 +1348,6 @@ export namespace tagmanager_v2 { * GTM Account ID. */ accountId?: string | null; - /** - * 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. */ @@ -1376,10 +1364,6 @@ export namespace tagmanager_v2 { * The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. */ 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. - */ - 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. */ diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index 8272c1f7c18..f0368f0e020 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -1231,7 +1231,7 @@ export namespace tasks_v1 { } /** - * Returns all tasks in the specified task list. Does not return assigned tasks be default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time. + * Returns all tasks in the specified task list. Doesn't return assigned tasks by default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 2a62798d70e..379c9910fae 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -254,6 +254,10 @@ export namespace testing_v1 { * A description of an Android device tests may be run on. */ export interface Schema$AndroidModel { + /** + * Reasons for access denial. This model is accessible if this list is empty, otherwise the model is viewable only. + */ + accessDeniedReasons?: string[] | null; /** * The company that this device is branded with. Example: "Google", "Samsung". */ @@ -2792,6 +2796,10 @@ export namespace testing_v1 { * Required. The type of environment that should be listed. */ environmentType?: string; + /** + * Optional. Whether to include viewable only models in the response. This is only applicable for Android models. + */ + includeViewableModels?: boolean; /** * For authorization, the cloud project requesting the TestEnvironmentCatalog. */ diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index 740766607fe..dd03a26ec84 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -160,7 +160,7 @@ export namespace texttospeech_v1 { */ sampleRateHertz?: number | null; /** - * Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or \> 4.0 will return an error. + * Optional. Input only. Speaking rate/speed, in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or \> 2.0 will return an error. */ speakingRate?: number | null; /** @@ -310,7 +310,7 @@ export namespace texttospeech_v1 { */ export interface Schema$SynthesisInput { /** - * Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag. + * Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag. */ customPronunciations?: Schema$CustomPronunciations; /** diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 6a15ba1f383..75037d6de3b 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -158,7 +158,7 @@ export namespace texttospeech_v1beta1 { */ sampleRateHertz?: number | null; /** - * Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or \> 4.0 will return an error. + * Optional. Input only. Speaking rate/speed, in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or \> 2.0 will return an error. */ speakingRate?: number | null; /** @@ -300,7 +300,7 @@ export namespace texttospeech_v1beta1 { */ export interface Schema$SynthesisInput { /** - * Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag. + * Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag. */ customPronunciations?: Schema$CustomPronunciations; /** diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index 590d11f1142..dea3d2caeba 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -693,6 +693,10 @@ export namespace tpu_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index 7d392e699d7..5e93dbd7061 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -693,6 +693,10 @@ export namespace tpu_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/tpu/v2.ts b/src/apis/tpu/v2.ts index 4624ce87a00..1547022f20c 100644 --- a/src/apis/tpu/v2.ts +++ b/src/apis/tpu/v2.ts @@ -579,6 +579,10 @@ export namespace tpu_v2 { * Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls. */ tags?: string[] | null; + /** + * Output only. Upcoming maintenance on this TPU node. + */ + upcomingMaintenance?: Schema$UpcomingMaintenance; } /** * Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created. @@ -902,6 +906,35 @@ export namespace tpu_v2 { */ nodeSpec?: Schema$NodeSpec[]; } + /** + * Upcoming Maintenance notification information. + */ + export interface Schema$UpcomingMaintenance { + /** + * Indicates if the maintenance can be customer triggered. + */ + canReschedule?: boolean | null; + /** + * The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + */ + latestWindowStartTime?: string | null; + /** + * The status of the maintenance. + */ + maintenanceStatus?: string | null; + /** + * Defines the type of maintenance. + */ + type?: string | null; + /** + * The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + */ + windowEndTime?: string | null; + /** + * The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + */ + windowStartTime?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -1234,6 +1267,10 @@ export namespace tpu_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/tpu/v2alpha1.ts b/src/apis/tpu/v2alpha1.ts index 4abd9f9829e..ef810857375 100644 --- a/src/apis/tpu/v2alpha1.ts +++ b/src/apis/tpu/v2alpha1.ts @@ -200,10 +200,26 @@ export namespace tpu_v2alpha1 { * Optional. Customer encryption key for boot disk. */ customerEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. + */ + diskSizeGb?: string | null; /** * Optional. Whether the boot disk will be created with confidential compute mode. */ enableConfidentialCompute?: boolean | null; + /** + * Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops). + */ + provisionedIops?: string | null; + /** + * Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. + */ + provisionedThroughput?: string | null; + /** + * Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`. + */ + sourceImage?: string | null; } /** * Further data for the creating state. @@ -759,6 +775,10 @@ export namespace tpu_v2alpha1 { * Output only. Immutable. The name of the QueuedResource. */ name?: string | null; + /** + * Optional. The provisioning model for the resource. + */ + provisioningModel?: string | null; /** * The queueing policy of the QueuedRequest. */ @@ -767,6 +787,10 @@ export namespace tpu_v2alpha1 { * Name of the reservation in which the resource should be provisioned. Format: projects/{project\}/locations/{zone\}/reservations/{reservation\} */ reservationName?: string | null; + /** + * Optional. The duration of the requested resource. + */ + runDuration?: Schema$RunDuration; /** * Optional. The Spot tier. */ @@ -871,6 +895,19 @@ export namespace tpu_v2alpha1 { * Request for ResetQueuedResource. */ export interface Schema$ResetQueuedResourceRequest {} + /** + * Defines the maximum lifetime of the requested resource. + */ + export interface Schema$RunDuration { + /** + * The maximum duration of the requested resource. + */ + maxRunDuration?: string | null; + /** + * The time at which the requested resource will be terminated. + */ + terminationTime?: string | null; + } /** * A runtime version that a Node can be configured with. */ @@ -892,6 +929,10 @@ export namespace tpu_v2alpha1 { * Defines whether the node is preemptible. */ preemptible?: boolean | null; + /** + * Optional. Defines the provisioning model for the node. + */ + provisioningModel?: string | null; /** * Whether the node is created under a reservation. */ @@ -1410,6 +1451,10 @@ export namespace tpu_v2alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/trafficdirector/v3.ts b/src/apis/trafficdirector/v3.ts index dda8355b19d..af840e24b65 100644 --- a/src/apis/trafficdirector/v3.ts +++ b/src/apis/trafficdirector/v3.ts @@ -711,7 +711,7 @@ export namespace trafficdirector_v3 { patch?: number | null; } /** - * [#next-free-field: 7] + * [#next-free-field: 8] */ export interface Schema$SocketAddress { /** @@ -726,6 +726,10 @@ export namespace trafficdirector_v3 { * This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution. */ namedPort?: string | null; + /** + * The Linux network namespace to bind the socket to. If this is set, Envoy will create the socket in the specified network namespace. Only supported on Linux. [#not-implemented-hide:] + */ + networkNamespaceFilepath?: string | null; portValue?: number | null; protocol?: string | null; /** diff --git a/src/apis/translate/v3.ts b/src/apis/translate/v3.ts index f71fed03884..d0fc2c323c7 100644 --- a/src/apis/translate/v3.ts +++ b/src/apis/translate/v3.ts @@ -2779,6 +2779,10 @@ export namespace translate_v3 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/translate/v3beta1.ts b/src/apis/translate/v3beta1.ts index 082f1c431a6..1969c8122b2 100644 --- a/src/apis/translate/v3beta1.ts +++ b/src/apis/translate/v3beta1.ts @@ -1860,6 +1860,10 @@ export namespace translate_v3beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 0b3da461ae5..7689109762c 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -590,7 +590,7 @@ export namespace vault_v1 { */ export interface Schema$HangoutsChatInfo { /** - * A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request. + * A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request. */ roomId?: string[] | null; } diff --git a/src/apis/verifiedaccess/v2.ts b/src/apis/verifiedaccess/v2.ts index 0967c4101d6..86af3f657c9 100644 --- a/src/apis/verifiedaccess/v2.ts +++ b/src/apis/verifiedaccess/v2.ts @@ -276,7 +276,7 @@ export namespace verifiedaccess_v2 { */ systemDnsServers?: string[] | null; /** - * 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. + * Output only. Deprecated. The corresponding policy is now deprecated. 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; /** @@ -310,7 +310,7 @@ export namespace verifiedaccess_v2 { expectedIdentity?: string | null; } /** - * Result message for VerifiedAccess.VerifyChallengeResponse. + * Result message for VerifiedAccess.VerifyChallengeResponse. The response returned when successful for Managed profiles on Unmanaged browsers will NOT have devicePermanentId, keyTrustLevel, virtualDeviceId and customerId fields. Managed profiles will INSTEAD have the profileCustomerId, virtualProfileId, profilePermanentId and profileKeyTrustLevel fields. */ export interface Schema$VerifyChallengeResponseResult { /** diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index a19504a0c52..8c98a6955c3 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -1396,6 +1396,10 @@ export namespace vmmigration_v1 { * Parameters affecting the OS adaptation process. */ export interface Schema$ImageImportOsAdaptationParameters { + /** + * Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion + */ + bootConversion?: string | null; /** * Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). */ @@ -2870,6 +2874,10 @@ export namespace vmmigration_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/vmmigration/v1alpha1.ts b/src/apis/vmmigration/v1alpha1.ts index 6f46c8a5db2..177244c924d 100644 --- a/src/apis/vmmigration/v1alpha1.ts +++ b/src/apis/vmmigration/v1alpha1.ts @@ -1417,6 +1417,10 @@ export namespace vmmigration_v1alpha1 { * Parameters affecting the OS adaptation process. */ export interface Schema$ImageImportOsAdaptationParameters { + /** + * Optional. By default the image will keep its existing boot option. Setting this property will trigger an internal process which will convert the image from using the existing boot option to another. The size of the boot disk might be increased to allow the conversion + */ + bootConversion?: string | null; /** * Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). */ @@ -3036,6 +3040,10 @@ export namespace vmmigration_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/vmwareengine/v1.ts b/src/apis/vmwareengine/v1.ts index 0549a892e54..b11dee4d01b 100644 --- a/src/apis/vmwareengine/v1.ts +++ b/src/apis/vmwareengine/v1.ts @@ -311,6 +311,10 @@ export namespace vmwareengine_v1 { * Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met. */ export interface Schema$Constraints { + /** + * Output only. Output Only. A list of intervals in which maintenance windows are not allowed. Any time window that overlaps with any of these intervals will be considered invalid. + */ + disallowedIntervals?: Schema$WeeklyTimeInterval[]; /** * 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. */ @@ -1929,6 +1933,27 @@ export namespace vmwareengine_v1 { */ type?: string | null; } + /** + * Represents a time interval, spanning across days of the week. Until local timezones are supported, this interval is in UTC. + */ + export interface Schema$WeeklyTimeInterval { + /** + * Output only. The day on which the interval ends. Can be same as start day. + */ + endDay?: string | null; + /** + * Output only. The time on the end day at which the interval ends. + */ + endTime?: Schema$TimeOfDay; + /** + * Output only. The day on which the interval starts. + */ + startDay?: string | null; + /** + * Output only. The time on the start day at which the interval starts. + */ + startTime?: Schema$TimeOfDay; + } export class Resource$Projects { context: APIRequestContext; @@ -2261,6 +2286,10 @@ export namespace vmwareengine_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/vpcaccess/v1.ts b/src/apis/vpcaccess/v1.ts index 9ef77d89b9c..997facb8880 100644 --- a/src/apis/vpcaccess/v1.ts +++ b/src/apis/vpcaccess/v1.ts @@ -475,6 +475,10 @@ export namespace vpcaccess_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/vpcaccess/v1beta1.ts b/src/apis/vpcaccess/v1beta1.ts index a1df1632bb2..8928024124f 100644 --- a/src/apis/vpcaccess/v1beta1.ts +++ b/src/apis/vpcaccess/v1beta1.ts @@ -483,6 +483,10 @@ export namespace vpcaccess_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/workflows/v1.ts b/src/apis/workflows/v1.ts index b81ffeb230e..ed6d0bb98c3 100644 --- a/src/apis/workflows/v1.ts +++ b/src/apis/workflows/v1.ts @@ -580,6 +580,10 @@ export namespace workflows_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/workflows/v1beta.ts b/src/apis/workflows/v1beta.ts index a4edd0b3fac..3b6777d504f 100644 --- a/src/apis/workflows/v1beta.ts +++ b/src/apis/workflows/v1beta.ts @@ -518,6 +518,10 @@ export namespace workflows_v1beta { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index 4c3337c476e..9610221f744 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -137,69 +137,6 @@ 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. */ @@ -247,19 +184,6 @@ export namespace workloadmanager_v1 { */ 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. */ @@ -302,27 +226,6 @@ export namespace workloadmanager_v1 { */ 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. */ @@ -341,7 +244,7 @@ export namespace workloadmanager_v1 { */ export interface Schema$Empty {} /** - * LINT.IfChange Message describing Evaluation object + * Message describing Evaluation object */ export interface Schema$Evaluation { /** @@ -508,23 +411,6 @@ 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 */ @@ -775,19 +661,6 @@ 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. */ @@ -1321,6 +1194,10 @@ export namespace workloadmanager_v1 { * Disk mount on the instance. */ export interface Schema$SapDiscoveryResourceInstancePropertiesDiskMount { + /** + * Optional. Names of the disks providing this mount point. + */ + diskNames?: string[] | null; /** * Optional. Filesystem mount point. */ @@ -1518,27 +1395,6 @@ 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). */ @@ -1573,27 +1429,6 @@ export namespace workloadmanager_v1 { */ newFixes?: string | null; } - /** - * The body of three tier workload - */ - export interface Schema$ThreeTierWorkload { - /** - * Output only. The API layer for three tier workload - */ - apiLayer?: Schema$APILayerServer; - /** - * Output only. The backend for three tier workload - */ - backend?: Schema$BackendServer; - /** - * 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. */ @@ -1631,6 +1466,10 @@ export namespace workloadmanager_v1 { * Optional. Maintenance status */ maintenanceStatus?: string | null; + /** + * Optional. Instance maintenance behavior. Could be "MIGRATE" or "TERMINATE". + */ + onHostMaintenance?: string | null; /** * Optional. Start time */ @@ -1689,18 +1528,10 @@ export namespace workloadmanager_v1 { * 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 */ @@ -1965,6 +1796,10 @@ export namespace workloadmanager_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ diff --git a/src/apis/workspaceevents/v1.ts b/src/apis/workspaceevents/v1.ts index 54858d1c9d7..293981f40d2 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 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). + * 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. Note: The Workspace Events API uses [ordering keys](https://cloud.google.com/pubsub/docs/ordering) for the benefit of sequential events. If the Cloud Pub/Sub topic has a [message storage policy](https://cloud.google.com/pubsub/docs/resource-location-restriction#exceptions) configured to exclude the nearest Google Cloud region, publishing events with ordering keys will fail. 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; } @@ -208,7 +208,7 @@ export namespace workspaceevents_v1 { message?: string | null; } /** - * [Developer Preview](https://developers.google.com/workspace/preview). A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events). + * A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events). */ export interface Schema$Subscription { /** @@ -379,7 +379,7 @@ export namespace workspaceevents_v1 { } /** - * [Developer Preview](https://developers.google.com/workspace/preview): Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). + * Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -465,7 +465,7 @@ export namespace workspaceevents_v1 { } /** - * [Developer Preview](https://developers.google.com/workspace/preview): Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription). + * Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -551,7 +551,7 @@ export namespace workspaceevents_v1 { } /** - * [Developer Preview](https://developers.google.com/workspace/preview): Gets details about a Google Workspace subscription. To learn how to use this method, see [Get details about a Google Workspace subscription](https://developers.google.com/workspace/events/guides/get-subscription). + * Gets details about a Google Workspace subscription. To learn how to use this method, see [Get details about a Google Workspace subscription](https://developers.google.com/workspace/events/guides/get-subscription). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -637,7 +637,7 @@ export namespace workspaceevents_v1 { } /** - * [Developer Preview](https://developers.google.com/workspace/preview): Lists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions). + * Lists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -730,7 +730,7 @@ export namespace workspaceevents_v1 { } /** - * [Developer Preview](https://developers.google.com/workspace/preview): Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). + * Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -816,7 +816,7 @@ export namespace workspaceevents_v1 { } /** - * [Developer Preview](https://developers.google.com/workspace/preview): Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). + * Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index fcf78db6db2..edc1ace60d5 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -406,7 +406,7 @@ export namespace workstations_v1 { */ 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. 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. + * 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, see [the filesystems available in Container-Optimized OS](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable. */ sourceSnapshot?: string | null; } @@ -431,7 +431,7 @@ export namespace workstations_v1 { */ sizeGb?: number | null; /** - * Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. + * Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. Must be formatted as ext4 file system with no partitions. */ sourceSnapshot?: string | null; } @@ -951,7 +951,7 @@ export namespace workstations_v1 { */ createTime?: string | null; /** - * Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. + * Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster. */ degraded?: boolean | null; /** @@ -995,7 +995,7 @@ export namespace workstations_v1 { */ subnetwork?: string | null; /** - * Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" */ tags?: {[key: string]: string} | null; /** @@ -1020,7 +1020,7 @@ export namespace workstations_v1 { */ annotations?: {[key: string]: string} | null; /** - * Output only. Status conditions describing the current resource state. + * Output only. Status conditions describing the workstation configuration's current state. */ conditions?: Schema$Status[]; /** @@ -1032,7 +1032,7 @@ export namespace workstations_v1 { */ createTime?: string | null; /** - * Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field. + * Output only. Whether this workstation configuration is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the configuration. */ degraded?: boolean | null; /** @@ -1327,6 +1327,10 @@ export namespace workstations_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * 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). */ @@ -2260,6 +2264,10 @@ export namespace workstations_v1 { } export interface Params$Resource$Projects$Locations$Workstationclusters$List extends StandardParameters { + /** + * Optional. Filter the WorkstationClusters to be listed. Possible filters are described in https://google.aip.dev/160. + */ + filter?: string; /** * Optional. Maximum number of items to return. */ @@ -3188,6 +3196,10 @@ export namespace workstations_v1 { } export interface Params$Resource$Projects$Locations$Workstationclusters$Workstationconfigs$List extends StandardParameters { + /** + * Optional. Filter the WorkstationConfigs to be listed. Possible filters are described in https://google.aip.dev/160. + */ + filter?: string; /** * Optional. Maximum number of items to return. */ @@ -4420,6 +4432,10 @@ export namespace workstations_v1 { } export interface Params$Resource$Projects$Locations$Workstationclusters$Workstationconfigs$Workstations$List extends StandardParameters { + /** + * Optional. Filter the Workstations to be listed. Possible filters are described in https://google.aip.dev/160. + */ + filter?: string; /** * Optional. Maximum number of items to return. */ diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index cbaa3e830a5..a48aebb2147 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -406,7 +406,7 @@ export namespace workstations_v1beta { */ 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. 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. + * 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, see [the filesystems available in Container-Optimized OS](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable. */ sourceSnapshot?: string | null; } @@ -431,7 +431,7 @@ export namespace workstations_v1beta { */ sizeGb?: number | null; /** - * Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. + * Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. Must be formatted as ext4 file system with no partitions. */ sourceSnapshot?: string | null; } @@ -853,7 +853,7 @@ export namespace workstations_v1beta { */ 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. + * Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the workstation. */ degraded?: boolean | null; /** @@ -955,7 +955,7 @@ export namespace workstations_v1beta { */ createTime?: string | null; /** - * Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. + * Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster. */ degraded?: boolean | null; /** @@ -1007,7 +1007,7 @@ export namespace workstations_v1beta { */ subnetwork?: string | null; /** - * Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" */ tags?: {[key: string]: string} | null; /** @@ -1032,7 +1032,7 @@ export namespace workstations_v1beta { */ annotations?: {[key: string]: string} | null; /** - * Output only. Status conditions describing the current resource state. + * Output only. Status conditions describing the workstation configuration's current state. */ conditions?: Schema$Status[]; /** @@ -1044,7 +1044,7 @@ export namespace workstations_v1beta { */ createTime?: string | null; /** - * Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field. + * Output only. Whether this workstation configuration is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the configuration. */ degraded?: boolean | null; /** @@ -2082,6 +2082,10 @@ export namespace workstations_v1beta { } export interface Params$Resource$Projects$Locations$Workstationclusters$List extends StandardParameters { + /** + * Optional. Filter the WorkstationClusters to be listed. Possible filters are described in https://google.aip.dev/160. + */ + filter?: string; /** * Optional. Maximum number of items to return. */ @@ -3010,6 +3014,10 @@ export namespace workstations_v1beta { } export interface Params$Resource$Projects$Locations$Workstationclusters$Workstationconfigs$List extends StandardParameters { + /** + * Optional. Filter the WorkstationConfigs to be listed. Possible filters are described in https://google.aip.dev/160. + */ + filter?: string; /** * Optional. Maximum number of items to return. */ @@ -4246,6 +4254,10 @@ export namespace workstations_v1beta { } export interface Params$Resource$Projects$Locations$Workstationclusters$Workstationconfigs$Workstations$List extends StandardParameters { + /** + * Optional. Filter the Workstations to be listed. Possible filters are described in https://google.aip.dev/160. + */ + filter?: string; /** * Optional. Maximum number of items to return. */ diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index df665f98f5e..dd0d32a0404 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -1261,7 +1261,7 @@ export namespace youtube_v3 { */ canRate?: boolean | null; /** - * The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel. + * The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. */ channelId?: string | null; /** @@ -1273,9 +1273,13 @@ export namespace youtube_v3 { */ moderationStatus?: string | null; /** - * The unique id of the parent comment, only set for replies. + * The unique id of the top-level comment, only set for replies. */ parentId?: string | null; + /** + * The ID of the post the comment refers to, if any. + */ + postId?: string | null; /** * The date and time when the comment was originally published. */ @@ -1302,9 +1306,12 @@ export namespace youtube_v3 { viewerRating?: string | null; } /** - * The id of the author's YouTube channel, if any. + * Contains the id of the author's YouTube channel, if any. */ export interface Schema$CommentSnippetAuthorChannelId { + /** + * The id of the author's YouTube channel. + */ value?: string | null; } /** @@ -1381,13 +1388,17 @@ export namespace youtube_v3 { */ canReply?: boolean | null; /** - * The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself. + * The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If neither video_id nor post_id is set the comments refer to the channel itself. */ channelId?: string | null; /** * Whether the thread (and therefore all its comments) is visible to all YouTube users. */ isPublic?: boolean | null; + /** + * The ID of the post the comments refer to, if any. + */ + postId?: string | null; /** * The top level comment of this thread. */ @@ -1397,7 +1408,7 @@ export namespace youtube_v3 { */ totalReplyCount?: number | null; /** - * The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment. + * The ID of the video the comments refer to, if any. */ videoId?: string | null; } @@ -7212,6 +7223,10 @@ export namespace youtube_v3 { * The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. */ part?: string[]; + /** + * Returns the comment threads of the specified post. + */ + postId?: string; /** * Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter. */ diff --git a/src/index.ts b/src/index.ts index fe764bbf728..781e949554f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -268,6 +268,7 @@ export {firebaseappcheck_v1beta} from './apis/firebaseappcheck/v1beta'; export {firebaseappdistribution_v1} from './apis/firebaseappdistribution/v1'; export {firebaseappdistribution_v1alpha} from './apis/firebaseappdistribution/v1alpha'; export {firebasedatabase_v1beta} from './apis/firebasedatabase/v1beta'; +export {firebasedataconnect_v1} from './apis/firebasedataconnect/v1'; export {firebasedataconnect_v1beta} from './apis/firebasedataconnect/v1beta'; export {firebasedynamiclinks_v1} from './apis/firebasedynamiclinks/v1'; export {firebasehosting_v1} from './apis/firebasehosting/v1'; @@ -390,6 +391,7 @@ export {networkservices_v1beta1} from './apis/networkservices/v1beta1'; export {notebooks_v1} from './apis/notebooks/v1'; export {notebooks_v2} from './apis/notebooks/v2'; export {oauth2_v2} from './apis/oauth2/v2'; +export {observability_v1} from './apis/observability/v1'; export {ondemandscanning_v1} from './apis/ondemandscanning/v1'; export {ondemandscanning_v1beta1} from './apis/ondemandscanning/v1beta1'; export {oracledatabase_v1} from './apis/oracledatabase/v1'; @@ -397,6 +399,7 @@ export {orgpolicy_v2} from './apis/orgpolicy/v2'; export {osconfig_v1} from './apis/osconfig/v1'; export {osconfig_v1alpha} from './apis/osconfig/v1alpha'; export {osconfig_v1beta} from './apis/osconfig/v1beta'; +export {osconfig_v2} from './apis/osconfig/v2'; export {osconfig_v2beta} from './apis/osconfig/v2beta'; export {oslogin_v1} from './apis/oslogin/v1'; export {oslogin_v1alpha} from './apis/oslogin/v1alpha'; @@ -499,6 +502,7 @@ export {sqladmin_v1} from './apis/sqladmin/v1'; export {sqladmin_v1beta4} from './apis/sqladmin/v1beta4'; export {storage_v1} from './apis/storage/v1'; export {storage_v1beta2} from './apis/storage/v1beta2'; +export {storagebatchoperations_v1} from './apis/storagebatchoperations/v1'; export {storagetransfer_v1} from './apis/storagetransfer/v1'; export {streetviewpublish_v1} from './apis/streetviewpublish/v1'; export {sts_v1} from './apis/sts/v1';